1 use crate::{LateContext, LateLintPass, LintContext};
3 use rustc_attr as attr;
4 use rustc_data_structures::fx::FxHashSet;
5 use rustc_errors::Applicability;
7 use rustc_hir::{is_range_literal, Expr, ExprKind, Node};
8 use rustc_middle::ty::layout::{IntegerExt, LayoutOf, SizeSkeleton};
9 use rustc_middle::ty::subst::SubstsRef;
10 use rustc_middle::ty::{self, AdtKind, DefIdTree, Ty, TyCtxt, TypeFoldable, TypeSuperFoldable};
11 use rustc_span::source_map;
12 use rustc_span::symbol::sym;
13 use rustc_span::{Span, Symbol, DUMMY_SP};
14 use rustc_target::abi::{Abi, WrappingRange};
15 use rustc_target::abi::{Integer, TagEncoding, Variants};
16 use rustc_target::spec::abi::Abi as SpecAbi;
20 use std::ops::ControlFlow;
24 /// The `unused_comparisons` lint detects comparisons made useless by
25 /// limits of the types involved.
39 /// A useless comparison may indicate a mistake, and should be fixed or
43 "comparisons made useless by limits of the types involved"
47 /// The `overflowing_literals` lint detects literal out of range for its
52 /// ```rust,compile_fail
60 /// It is usually a mistake to use a literal that overflows the type where
61 /// it is used. Either use a literal that is within range, or change the
62 /// type to be within the range of the literal.
65 "literal out of range for its type"
69 /// The `variant_size_differences` lint detects enums with widely varying
74 /// ```rust,compile_fail
75 /// #![deny(variant_size_differences)]
86 /// It can be a mistake to add a variant to an enum that is much larger
87 /// than the other variants, bloating the overall size required for all
88 /// variants. This can impact performance and memory usage. This is
89 /// triggered if one variant is more than 3 times larger than the
90 /// second-largest variant.
92 /// Consider placing the large variant's contents on the heap (for example
93 /// via [`Box`]) to keep the overall size of the enum itself down.
95 /// This lint is "allow" by default because it can be noisy, and may not be
96 /// an actual problem. Decisions about this should be guided with
97 /// profiling and benchmarking.
99 /// [`Box`]: https://doc.rust-lang.org/std/boxed/index.html
100 VARIANT_SIZE_DIFFERENCES,
102 "detects enums with widely varying variant sizes"
105 #[derive(Copy, Clone)]
106 pub struct TypeLimits {
107 /// Id of the last visited negated expression
108 negated_expr_id: Option<hir::HirId>,
111 impl_lint_pass!(TypeLimits => [UNUSED_COMPARISONS, OVERFLOWING_LITERALS]);
114 pub fn new() -> TypeLimits {
115 TypeLimits { negated_expr_id: None }
119 /// Attempts to special-case the overflowing literal lint when it occurs as a range endpoint.
120 /// Returns `true` iff the lint was overridden.
121 fn lint_overflowing_range_endpoint<'tcx>(
122 cx: &LateContext<'tcx>,
126 expr: &'tcx hir::Expr<'tcx>,
127 parent_expr: &'tcx hir::Expr<'tcx>,
130 // We only want to handle exclusive (`..`) ranges,
131 // which are represented as `ExprKind::Struct`.
132 let mut overwritten = false;
133 if let ExprKind::Struct(_, eps, _) = &parent_expr.kind {
137 // We can suggest using an inclusive range
138 // (`..=`) instead only if it is the `end` that is
139 // overflowing and only by 1.
140 if eps[1].expr.hir_id == expr.hir_id && lit_val - 1 == max {
141 cx.struct_span_lint(OVERFLOWING_LITERALS, parent_expr.span, |lint| {
142 let mut err = lint.build(&format!("range endpoint is out of range for `{}`", ty));
143 if let Ok(start) = cx.sess().source_map().span_to_snippet(eps[0].span) {
144 use ast::{LitIntType, LitKind};
145 // We need to preserve the literal's suffix,
146 // as it may determine typing information.
147 let suffix = match lit.node {
148 LitKind::Int(_, LitIntType::Signed(s)) => s.name_str(),
149 LitKind::Int(_, LitIntType::Unsigned(s)) => s.name_str(),
150 LitKind::Int(_, LitIntType::Unsuffixed) => "",
153 let suggestion = format!("{}..={}{}", start, lit_val - 1, suffix);
156 "use an inclusive range instead",
158 Applicability::MachineApplicable,
169 // For `isize` & `usize`, be conservative with the warnings, so that the
170 // warnings are consistent between 32- and 64-bit platforms.
171 fn int_ty_range(int_ty: ty::IntTy) -> (i128, i128) {
173 ty::IntTy::Isize => (i64::MIN.into(), i64::MAX.into()),
174 ty::IntTy::I8 => (i8::MIN.into(), i8::MAX.into()),
175 ty::IntTy::I16 => (i16::MIN.into(), i16::MAX.into()),
176 ty::IntTy::I32 => (i32::MIN.into(), i32::MAX.into()),
177 ty::IntTy::I64 => (i64::MIN.into(), i64::MAX.into()),
178 ty::IntTy::I128 => (i128::MIN, i128::MAX),
182 fn uint_ty_range(uint_ty: ty::UintTy) -> (u128, u128) {
183 let max = match uint_ty {
184 ty::UintTy::Usize => u64::MAX.into(),
185 ty::UintTy::U8 => u8::MAX.into(),
186 ty::UintTy::U16 => u16::MAX.into(),
187 ty::UintTy::U32 => u32::MAX.into(),
188 ty::UintTy::U64 => u64::MAX.into(),
189 ty::UintTy::U128 => u128::MAX,
194 fn get_bin_hex_repr(cx: &LateContext<'_>, lit: &hir::Lit) -> Option<String> {
195 let src = cx.sess().source_map().span_to_snippet(lit.span).ok()?;
196 let firstch = src.chars().next()?;
199 match src.chars().nth(1) {
200 Some('x' | 'b') => return Some(src),
208 fn report_bin_hex_error(
209 cx: &LateContext<'_>,
210 expr: &hir::Expr<'_>,
216 let size = Integer::from_attr(&cx.tcx, ty).size();
217 cx.struct_span_lint(OVERFLOWING_LITERALS, expr.span, |lint| {
218 let (t, actually) = match ty {
219 attr::IntType::SignedInt(t) => {
220 let actually = if negative {
221 -(size.sign_extend(val) as i128)
223 size.sign_extend(val) as i128
225 (t.name_str(), actually.to_string())
227 attr::IntType::UnsignedInt(t) => {
228 let actually = size.truncate(val);
229 (t.name_str(), actually.to_string())
232 let mut err = lint.build(&format!("literal out of range for `{}`", t));
234 // If the value is negative,
235 // emits a note about the value itself, apart from the literal.
237 "the literal `{}` (decimal `{}`) does not fit into \
241 err.note(&format!("and the value `-{}` will become `{}{}`", repr_str, actually, t));
244 "the literal `{}` (decimal `{}`) does not fit into \
245 the type `{}` and will become `{}{}`",
246 repr_str, val, t, actually, t
249 if let Some(sugg_ty) =
250 get_type_suggestion(cx.typeck_results().node_type(expr.hir_id), val, negative)
252 if let Some(pos) = repr_str.chars().position(|c| c == 'i' || c == 'u') {
253 let (sans_suffix, _) = repr_str.split_at(pos);
256 &format!("consider using the type `{}` instead", sugg_ty),
257 format!("{}{}", sans_suffix, sugg_ty),
258 Applicability::MachineApplicable,
261 err.help(&format!("consider using the type `{}` instead", sugg_ty));
268 // This function finds the next fitting type and generates a suggestion string.
269 // It searches for fitting types in the following way (`X < Y`):
270 // - `iX`: if literal fits in `uX` => `uX`, else => `iY`
274 // No suggestion for: `isize`, `usize`.
275 fn get_type_suggestion(t: Ty<'_>, val: u128, negative: bool) -> Option<&'static str> {
278 macro_rules! find_fit {
279 ($ty:expr, $val:expr, $negative:expr,
280 $($type:ident => [$($utypes:expr),*] => [$($itypes:expr),*]),+) => {
282 let _neg = if negative { 1 } else { 0 };
285 $(if !negative && val <= uint_ty_range($utypes).1 {
286 return Some($utypes.name_str())
288 $(if val <= int_ty_range($itypes).1 as u128 + _neg {
289 return Some($itypes.name_str())
299 ty::Int(i) => find_fit!(i, val, negative,
300 I8 => [U8] => [I16, I32, I64, I128],
301 I16 => [U16] => [I32, I64, I128],
302 I32 => [U32] => [I64, I128],
303 I64 => [U64] => [I128],
304 I128 => [U128] => []),
305 ty::Uint(u) => find_fit!(u, val, negative,
306 U8 => [U8, U16, U32, U64, U128] => [],
307 U16 => [U16, U32, U64, U128] => [],
308 U32 => [U32, U64, U128] => [],
309 U64 => [U64, U128] => [],
310 U128 => [U128] => []),
315 fn lint_int_literal<'tcx>(
316 cx: &LateContext<'tcx>,
317 type_limits: &TypeLimits,
318 e: &'tcx hir::Expr<'tcx>,
323 let int_type = t.normalize(cx.sess().target.pointer_width);
324 let (min, max) = int_ty_range(int_type);
325 let max = max as u128;
326 let negative = type_limits.negated_expr_id == Some(e.hir_id);
328 // Detect literal value out of range [min, max] inclusive
329 // avoiding use of -min to prevent overflow/panic
330 if (negative && v > max + 1) || (!negative && v > max) {
331 if let Some(repr_str) = get_bin_hex_repr(cx, lit) {
332 report_bin_hex_error(
335 attr::IntType::SignedInt(ty::ast_int_ty(t)),
343 let par_id = cx.tcx.hir().get_parent_node(e.hir_id);
344 if let Node::Expr(par_e) = cx.tcx.hir().get(par_id) {
345 if let hir::ExprKind::Struct(..) = par_e.kind {
346 if is_range_literal(par_e)
347 && lint_overflowing_range_endpoint(cx, lit, v, max, e, par_e, t.name_str())
349 // The overflowing literal lint was overridden.
355 cx.struct_span_lint(OVERFLOWING_LITERALS, e.span, |lint| {
356 let mut err = lint.build(&format!("literal out of range for `{}`", t.name_str()));
358 "the literal `{}` does not fit into the type `{}` whose range is `{}..={}`",
361 .span_to_snippet(lit.span)
362 .expect("must get snippet from literal"),
367 if let Some(sugg_ty) =
368 get_type_suggestion(cx.typeck_results().node_type(e.hir_id), v, negative)
370 err.help(&format!("consider using the type `{}` instead", sugg_ty));
377 fn lint_uint_literal<'tcx>(
378 cx: &LateContext<'tcx>,
379 e: &'tcx hir::Expr<'tcx>,
383 let uint_type = t.normalize(cx.sess().target.pointer_width);
384 let (min, max) = uint_ty_range(uint_type);
385 let lit_val: u128 = match lit.node {
386 // _v is u8, within range by definition
387 ast::LitKind::Byte(_v) => return,
388 ast::LitKind::Int(v, _) => v,
391 if lit_val < min || lit_val > max {
392 let parent_id = cx.tcx.hir().get_parent_node(e.hir_id);
393 if let Node::Expr(par_e) = cx.tcx.hir().get(parent_id) {
395 hir::ExprKind::Cast(..) => {
396 if let ty::Char = cx.typeck_results().expr_ty(par_e).kind() {
397 cx.struct_span_lint(OVERFLOWING_LITERALS, par_e.span, |lint| {
398 lint.build("only `u8` can be cast into `char`")
401 "use a `char` literal instead",
402 format!("'\\u{{{:X}}}'", lit_val),
403 Applicability::MachineApplicable,
410 hir::ExprKind::Struct(..) if is_range_literal(par_e) => {
411 let t = t.name_str();
412 if lint_overflowing_range_endpoint(cx, lit, lit_val, max, e, par_e, t) {
413 // The overflowing literal lint was overridden.
420 if let Some(repr_str) = get_bin_hex_repr(cx, lit) {
421 report_bin_hex_error(
424 attr::IntType::UnsignedInt(ty::ast_uint_ty(t)),
431 cx.struct_span_lint(OVERFLOWING_LITERALS, e.span, |lint| {
432 lint.build(&format!("literal out of range for `{}`", t.name_str()))
434 "the literal `{}` does not fit into the type `{}` whose range is `{}..={}`",
437 .span_to_snippet(lit.span)
438 .expect("must get snippet from literal"),
448 fn lint_literal<'tcx>(
449 cx: &LateContext<'tcx>,
450 type_limits: &TypeLimits,
451 e: &'tcx hir::Expr<'tcx>,
454 match *cx.typeck_results().node_type(e.hir_id).kind() {
457 ast::LitKind::Int(v, ast::LitIntType::Signed(_) | ast::LitIntType::Unsuffixed) => {
458 lint_int_literal(cx, type_limits, e, lit, t, v)
463 ty::Uint(t) => lint_uint_literal(cx, e, lit, t),
465 let is_infinite = match lit.node {
466 ast::LitKind::Float(v, _) => match t {
467 ty::FloatTy::F32 => v.as_str().parse().map(f32::is_infinite),
468 ty::FloatTy::F64 => v.as_str().parse().map(f64::is_infinite),
472 if is_infinite == Ok(true) {
473 cx.struct_span_lint(OVERFLOWING_LITERALS, e.span, |lint| {
474 lint.build(&format!("literal out of range for `{}`", t.name_str()))
476 "the literal `{}` does not fit into the type `{}` and will be converted to `{}::INFINITY`",
479 .span_to_snippet(lit.span)
480 .expect("must get snippet from literal"),
492 impl<'tcx> LateLintPass<'tcx> for TypeLimits {
493 fn check_expr(&mut self, cx: &LateContext<'tcx>, e: &'tcx hir::Expr<'tcx>) {
495 hir::ExprKind::Unary(hir::UnOp::Neg, ref expr) => {
496 // propagate negation, if the negation itself isn't negated
497 if self.negated_expr_id != Some(e.hir_id) {
498 self.negated_expr_id = Some(expr.hir_id);
501 hir::ExprKind::Binary(binop, ref l, ref r) => {
502 if is_comparison(binop) && !check_limits(cx, binop, &l, &r) {
503 cx.struct_span_lint(UNUSED_COMPARISONS, e.span, |lint| {
504 lint.build("comparison is useless due to type limits").emit();
508 hir::ExprKind::Lit(ref lit) => lint_literal(cx, self, e, lit),
512 fn is_valid<T: cmp::PartialOrd>(binop: hir::BinOp, v: T, min: T, max: T) -> bool {
514 hir::BinOpKind::Lt => v > min && v <= max,
515 hir::BinOpKind::Le => v >= min && v < max,
516 hir::BinOpKind::Gt => v >= min && v < max,
517 hir::BinOpKind::Ge => v > min && v <= max,
518 hir::BinOpKind::Eq | hir::BinOpKind::Ne => v >= min && v <= max,
523 fn rev_binop(binop: hir::BinOp) -> hir::BinOp {
527 hir::BinOpKind::Lt => hir::BinOpKind::Gt,
528 hir::BinOpKind::Le => hir::BinOpKind::Ge,
529 hir::BinOpKind::Gt => hir::BinOpKind::Lt,
530 hir::BinOpKind::Ge => hir::BinOpKind::Le,
537 cx: &LateContext<'_>,
542 let (lit, expr, swap) = match (&l.kind, &r.kind) {
543 (&hir::ExprKind::Lit(_), _) => (l, r, true),
544 (_, &hir::ExprKind::Lit(_)) => (r, l, false),
547 // Normalize the binop so that the literal is always on the RHS in
549 let norm_binop = if swap { rev_binop(binop) } else { binop };
550 match *cx.typeck_results().node_type(expr.hir_id).kind() {
552 let (min, max) = int_ty_range(int_ty);
553 let lit_val: i128 = match lit.kind {
554 hir::ExprKind::Lit(ref li) => match li.node {
557 ast::LitIntType::Signed(_) | ast::LitIntType::Unsuffixed,
563 is_valid(norm_binop, lit_val, min, max)
565 ty::Uint(uint_ty) => {
566 let (min, max): (u128, u128) = uint_ty_range(uint_ty);
567 let lit_val: u128 = match lit.kind {
568 hir::ExprKind::Lit(ref li) => match li.node {
569 ast::LitKind::Int(v, _) => v,
574 is_valid(norm_binop, lit_val, min, max)
580 fn is_comparison(binop: hir::BinOp) -> bool {
595 /// The `improper_ctypes` lint detects incorrect use of types in foreign
602 /// static STATIC: String;
610 /// The compiler has several checks to verify that types used in `extern`
611 /// blocks are safe and follow certain rules to ensure proper
612 /// compatibility with the foreign interfaces. This lint is issued when it
613 /// detects a probable mistake in a definition. The lint usually should
614 /// provide a description of the issue, along with possibly a hint on how
618 "proper use of libc types in foreign modules"
621 declare_lint_pass!(ImproperCTypesDeclarations => [IMPROPER_CTYPES]);
624 /// The `improper_ctypes_definitions` lint detects incorrect use of
625 /// [`extern` function] definitions.
627 /// [`extern` function]: https://doc.rust-lang.org/reference/items/functions.html#extern-function-qualifier
632 /// # #![allow(unused)]
633 /// pub extern "C" fn str_type(p: &str) { }
640 /// There are many parameter and return types that may be specified in an
641 /// `extern` function that are not compatible with the given ABI. This
642 /// lint is an alert that these types should not be used. The lint usually
643 /// should provide a description of the issue, along with possibly a hint
644 /// on how to resolve it.
645 IMPROPER_CTYPES_DEFINITIONS,
647 "proper use of libc types in foreign item definitions"
650 declare_lint_pass!(ImproperCTypesDefinitions => [IMPROPER_CTYPES_DEFINITIONS]);
652 #[derive(Clone, Copy)]
653 pub(crate) enum CItemKind {
658 struct ImproperCTypesVisitor<'a, 'tcx> {
659 cx: &'a LateContext<'tcx>,
663 enum FfiResult<'tcx> {
665 FfiPhantom(Ty<'tcx>),
666 FfiUnsafe { ty: Ty<'tcx>, reason: String, help: Option<String> },
669 pub(crate) fn nonnull_optimization_guaranteed<'tcx>(
671 def: ty::AdtDef<'tcx>,
673 tcx.has_attr(def.did(), sym::rustc_nonnull_optimization_guaranteed)
676 /// `repr(transparent)` structs can have a single non-ZST field, this function returns that
678 pub fn transparent_newtype_field<'a, 'tcx>(
680 variant: &'a ty::VariantDef,
681 ) -> Option<&'a ty::FieldDef> {
682 let param_env = tcx.param_env(variant.def_id);
683 variant.fields.iter().find(|field| {
684 let field_ty = tcx.type_of(field.did);
685 let is_zst = tcx.layout_of(param_env.and(field_ty)).map_or(false, |layout| layout.is_zst());
690 /// Is type known to be non-null?
691 fn ty_is_known_nonnull<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>, mode: CItemKind) -> bool {
694 ty::FnPtr(_) => true,
696 ty::Adt(def, _) if def.is_box() && matches!(mode, CItemKind::Definition) => true,
697 ty::Adt(def, substs) if def.repr().transparent() && !def.is_union() => {
698 let marked_non_null = nonnull_optimization_guaranteed(tcx, *def);
704 // Types with a `#[repr(no_niche)]` attribute have their niche hidden.
705 // The attribute is used by the UnsafeCell for example (the only use so far).
706 if def.repr().hide_niche() {
712 .filter_map(|variant| transparent_newtype_field(cx.tcx, variant))
713 .any(|field| ty_is_known_nonnull(cx, field.ty(tcx, substs), mode))
719 /// Given a non-null scalar (or transparent) type `ty`, return the nullable version of that type.
720 /// If the type passed in was not scalar, returns None.
721 fn get_nullable_type<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> Option<Ty<'tcx>> {
723 Some(match *ty.kind() {
724 ty::Adt(field_def, field_substs) => {
725 let inner_field_ty = {
726 let first_non_zst_ty = field_def
729 .filter_map(|v| transparent_newtype_field(cx.tcx, v));
731 first_non_zst_ty.clone().count(),
733 "Wrong number of fields for transparent type"
737 .expect("No non-zst fields in transparent type.")
738 .ty(tcx, field_substs)
740 return get_nullable_type(cx, inner_field_ty);
742 ty::Int(ty) => tcx.mk_mach_int(ty),
743 ty::Uint(ty) => tcx.mk_mach_uint(ty),
744 ty::RawPtr(ty_mut) => tcx.mk_ptr(ty_mut),
745 // As these types are always non-null, the nullable equivalent of
746 // Option<T> of these types are their raw pointer counterparts.
747 ty::Ref(_region, ty, mutbl) => tcx.mk_ptr(ty::TypeAndMut { ty, mutbl }),
749 // There is no nullable equivalent for Rust's function pointers -- you
750 // must use an Option<fn(..) -> _> to represent it.
754 // We should only ever reach this case if ty_is_known_nonnull is extended
758 "get_nullable_type: Unhandled scalar kind: {:?} while checking {:?}",
766 /// Check if this enum can be safely exported based on the "nullable pointer optimization". If it
767 /// can, return the type that `ty` can be safely converted to, otherwise return `None`.
768 /// Currently restricted to function pointers, boxes, references, `core::num::NonZero*`,
769 /// `core::ptr::NonNull`, and `#[repr(transparent)]` newtypes.
770 /// FIXME: This duplicates code in codegen.
771 pub(crate) fn repr_nullable_ptr<'tcx>(
772 cx: &LateContext<'tcx>,
775 ) -> Option<Ty<'tcx>> {
776 debug!("is_repr_nullable_ptr(cx, ty = {:?})", ty);
777 if let ty::Adt(ty_def, substs) = ty.kind() {
778 let field_ty = match &ty_def.variants().raw[..] {
779 [var_one, var_two] => match (&var_one.fields[..], &var_two.fields[..]) {
780 ([], [field]) | ([field], []) => field.ty(cx.tcx, substs),
786 if !ty_is_known_nonnull(cx, field_ty, ckind) {
790 // At this point, the field's type is known to be nonnull and the parent enum is Option-like.
791 // If the computed size for the field and the enum are different, the nonnull optimization isn't
792 // being applied (and we've got a problem somewhere).
793 let compute_size_skeleton = |t| SizeSkeleton::compute(t, cx.tcx, cx.param_env).unwrap();
794 if !compute_size_skeleton(ty).same_size(compute_size_skeleton(field_ty)) {
795 bug!("improper_ctypes: Option nonnull optimization not applied?");
798 // Return the nullable type this Option-like enum can be safely represented with.
799 let field_ty_abi = &cx.layout_of(field_ty).unwrap().abi;
800 if let Abi::Scalar(field_ty_scalar) = field_ty_abi {
801 match field_ty_scalar.valid_range(cx) {
802 WrappingRange { start: 0, end }
803 if end == field_ty_scalar.size(&cx.tcx).unsigned_int_max() - 1 =>
805 return Some(get_nullable_type(cx, field_ty).unwrap());
807 WrappingRange { start: 1, .. } => {
808 return Some(get_nullable_type(cx, field_ty).unwrap());
810 WrappingRange { start, end } => {
811 unreachable!("Unhandled start and end range: ({}, {})", start, end)
819 impl<'a, 'tcx> ImproperCTypesVisitor<'a, 'tcx> {
820 /// Check if the type is array and emit an unsafe type lint.
821 fn check_for_array_ty(&mut self, sp: Span, ty: Ty<'tcx>) -> bool {
822 if let ty::Array(..) = ty.kind() {
823 self.emit_ffi_unsafe_type_lint(
826 "passing raw arrays by value is not FFI-safe",
827 Some("consider passing a pointer to the array"),
835 /// Checks if the given field's type is "ffi-safe".
836 fn check_field_type_for_ffi(
838 cache: &mut FxHashSet<Ty<'tcx>>,
839 field: &ty::FieldDef,
840 substs: SubstsRef<'tcx>,
841 ) -> FfiResult<'tcx> {
842 let field_ty = field.ty(self.cx.tcx, substs);
843 if field_ty.has_opaque_types() {
844 self.check_type_for_ffi(cache, field_ty)
846 let field_ty = self.cx.tcx.normalize_erasing_regions(self.cx.param_env, field_ty);
847 self.check_type_for_ffi(cache, field_ty)
851 /// Checks if the given `VariantDef`'s field types are "ffi-safe".
852 fn check_variant_for_ffi(
854 cache: &mut FxHashSet<Ty<'tcx>>,
856 def: ty::AdtDef<'tcx>,
857 variant: &ty::VariantDef,
858 substs: SubstsRef<'tcx>,
859 ) -> FfiResult<'tcx> {
862 if def.repr().transparent() {
863 // Can assume that at most one field is not a ZST, so only check
864 // that field's type for FFI-safety.
865 if let Some(field) = transparent_newtype_field(self.cx.tcx, variant) {
866 self.check_field_type_for_ffi(cache, field, substs)
868 // All fields are ZSTs; this means that the type should behave
869 // like (), which is FFI-unsafe
872 reason: "this struct contains only zero-sized fields".into(),
877 // We can't completely trust repr(C) markings; make sure the fields are
879 let mut all_phantom = !variant.fields.is_empty();
880 for field in &variant.fields {
881 match self.check_field_type_for_ffi(cache, &field, substs) {
885 FfiPhantom(..) if def.is_enum() => {
888 reason: "this enum contains a PhantomData field".into(),
897 if all_phantom { FfiPhantom(ty) } else { FfiSafe }
901 /// Checks if the given type is "ffi-safe" (has a stable, well-defined
902 /// representation which can be exported to C code).
903 fn check_type_for_ffi(&self, cache: &mut FxHashSet<Ty<'tcx>>, ty: Ty<'tcx>) -> FfiResult<'tcx> {
906 let tcx = self.cx.tcx;
908 // Protect against infinite recursion, for example
909 // `struct S(*mut S);`.
910 // FIXME: A recursion limit is necessary as well, for irregular
912 if !cache.insert(ty) {
917 ty::Adt(def, substs) => {
918 if def.is_box() && matches!(self.mode, CItemKind::Definition) {
919 if ty.boxed_ty().is_sized(tcx.at(DUMMY_SP), self.cx.param_env) {
924 reason: "box cannot be represented as a single pointer".to_string(),
929 if def.is_phantom_data() {
930 return FfiPhantom(ty);
932 match def.adt_kind() {
933 AdtKind::Struct | AdtKind::Union => {
934 let kind = if def.is_struct() { "struct" } else { "union" };
936 if !def.repr().c() && !def.repr().transparent() {
939 reason: format!("this {} has unspecified layout", kind),
941 "consider adding a `#[repr(C)]` or \
942 `#[repr(transparent)]` attribute to this {}",
948 let is_non_exhaustive =
949 def.non_enum_variant().is_field_list_non_exhaustive();
950 if is_non_exhaustive && !def.did().is_local() {
953 reason: format!("this {} is non-exhaustive", kind),
958 if def.non_enum_variant().fields.is_empty() {
961 reason: format!("this {} has no fields", kind),
962 help: Some(format!("consider adding a member to this {}", kind)),
966 self.check_variant_for_ffi(cache, ty, def, def.non_enum_variant(), substs)
969 if def.variants().is_empty() {
970 // Empty enums are okay... although sort of useless.
974 // Check for a repr() attribute to specify the size of the
976 if !def.repr().c() && !def.repr().transparent() && def.repr().int.is_none()
978 // Special-case types like `Option<extern fn()>`.
979 if repr_nullable_ptr(self.cx, ty, self.mode).is_none() {
982 reason: "enum has no representation hint".into(),
984 "consider adding a `#[repr(C)]`, \
985 `#[repr(transparent)]`, or integer `#[repr(...)]` \
986 attribute to this enum"
993 if def.is_variant_list_non_exhaustive() && !def.did().is_local() {
996 reason: "this enum is non-exhaustive".into(),
1001 // Check the contained variants.
1002 for variant in def.variants() {
1003 let is_non_exhaustive = variant.is_field_list_non_exhaustive();
1004 if is_non_exhaustive && !variant.def_id.is_local() {
1007 reason: "this enum has non-exhaustive variants".into(),
1012 match self.check_variant_for_ffi(cache, ty, def, variant, substs) {
1023 ty::Char => FfiUnsafe {
1025 reason: "the `char` type has no C equivalent".into(),
1026 help: Some("consider using `u32` or `libc::wchar_t` instead".into()),
1029 ty::Int(ty::IntTy::I128) | ty::Uint(ty::UintTy::U128) => FfiUnsafe {
1031 reason: "128-bit integers don't currently have a known stable ABI".into(),
1035 // Primitive types with a stable representation.
1036 ty::Bool | ty::Int(..) | ty::Uint(..) | ty::Float(..) | ty::Never => FfiSafe,
1038 ty::Slice(_) => FfiUnsafe {
1040 reason: "slices have no C equivalent".into(),
1041 help: Some("consider using a raw pointer instead".into()),
1044 ty::Dynamic(..) => {
1045 FfiUnsafe { ty, reason: "trait objects have no C equivalent".into(), help: None }
1048 ty::Str => FfiUnsafe {
1050 reason: "string slices have no C equivalent".into(),
1051 help: Some("consider using `*const u8` and a length instead".into()),
1054 ty::Tuple(..) => FfiUnsafe {
1056 reason: "tuples have unspecified layout".into(),
1057 help: Some("consider using a struct instead".into()),
1060 ty::RawPtr(ty::TypeAndMut { ty, .. }) | ty::Ref(_, ty, _)
1062 matches!(self.mode, CItemKind::Definition)
1063 && ty.is_sized(self.cx.tcx.at(DUMMY_SP), self.cx.param_env)
1069 ty::RawPtr(ty::TypeAndMut { ty, .. })
1070 if match ty.kind() {
1071 ty::Tuple(tuple) => tuple.is_empty(),
1078 ty::RawPtr(ty::TypeAndMut { ty, .. }) | ty::Ref(_, ty, _) => {
1079 self.check_type_for_ffi(cache, ty)
1082 ty::Array(inner_ty, _) => self.check_type_for_ffi(cache, inner_ty),
1085 if self.is_internal_abi(sig.abi()) {
1088 reason: "this function pointer has Rust-specific calling convention".into(),
1090 "consider using an `extern fn(...) -> ...` \
1091 function pointer instead"
1097 let sig = tcx.erase_late_bound_regions(sig);
1098 if !sig.output().is_unit() {
1099 let r = self.check_type_for_ffi(cache, sig.output());
1107 for arg in sig.inputs() {
1108 let r = self.check_type_for_ffi(cache, *arg);
1119 ty::Foreign(..) => FfiSafe,
1121 // While opaque types are checked for earlier, if a projection in a struct field
1122 // normalizes to an opaque type, then it will reach this branch.
1124 FfiUnsafe { ty, reason: "opaque types have no C equivalent".into(), help: None }
1127 // `extern "C" fn` functions can have type parameters, which may or may not be FFI-safe,
1128 // so they are currently ignored for the purposes of this lint.
1129 ty::Param(..) | ty::Projection(..) if matches!(self.mode, CItemKind::Definition) => {
1134 | ty::Projection(..)
1140 | ty::GeneratorWitness(..)
1141 | ty::Placeholder(..)
1142 | ty::FnDef(..) => bug!("unexpected type in foreign function: {:?}", ty),
1146 fn emit_ffi_unsafe_type_lint(
1153 let lint = match self.mode {
1154 CItemKind::Declaration => IMPROPER_CTYPES,
1155 CItemKind::Definition => IMPROPER_CTYPES_DEFINITIONS,
1158 self.cx.struct_span_lint(lint, sp, |lint| {
1159 let item_description = match self.mode {
1160 CItemKind::Declaration => "block",
1161 CItemKind::Definition => "fn",
1163 let mut diag = lint.build(&format!(
1164 "`extern` {} uses type `{}`, which is not FFI-safe",
1165 item_description, ty
1167 diag.span_label(sp, "not FFI-safe");
1168 if let Some(help) = help {
1172 if let ty::Adt(def, _) = ty.kind() {
1173 if let Some(sp) = self.cx.tcx.hir().span_if_local(def.did()) {
1174 diag.span_note(sp, "the type is defined here");
1181 fn check_for_opaque_ty(&mut self, sp: Span, ty: Ty<'tcx>) -> bool {
1182 struct ProhibitOpaqueTypes<'a, 'tcx> {
1183 cx: &'a LateContext<'tcx>,
1186 impl<'a, 'tcx> ty::fold::TypeVisitor<'tcx> for ProhibitOpaqueTypes<'a, 'tcx> {
1187 type BreakTy = Ty<'tcx>;
1189 fn visit_ty(&mut self, ty: Ty<'tcx>) -> ControlFlow<Self::BreakTy> {
1191 ty::Opaque(..) => ControlFlow::Break(ty),
1192 // Consider opaque types within projections FFI-safe if they do not normalize
1193 // to more opaque types.
1194 ty::Projection(..) => {
1195 let ty = self.cx.tcx.normalize_erasing_regions(self.cx.param_env, ty);
1197 // If `ty` is an opaque type directly then `super_visit_with` won't invoke
1198 // this function again.
1199 if ty.has_opaque_types() {
1202 ControlFlow::CONTINUE
1205 _ => ty.super_visit_with(self),
1210 if let Some(ty) = ty.visit_with(&mut ProhibitOpaqueTypes { cx: self.cx }).break_value() {
1211 self.emit_ffi_unsafe_type_lint(ty, sp, "opaque types have no C equivalent", None);
1218 fn check_type_for_ffi_and_report_errors(
1223 is_return_type: bool,
1225 // We have to check for opaque types before `normalize_erasing_regions`,
1226 // which will replace opaque types with their underlying concrete type.
1227 if self.check_for_opaque_ty(sp, ty) {
1228 // We've already emitted an error due to an opaque type.
1232 // it is only OK to use this function because extern fns cannot have
1233 // any generic types right now:
1234 let ty = self.cx.tcx.normalize_erasing_regions(self.cx.param_env, ty);
1236 // C doesn't really support passing arrays by value - the only way to pass an array by value
1237 // is through a struct. So, first test that the top level isn't an array, and then
1238 // recursively check the types inside.
1239 if !is_static && self.check_for_array_ty(sp, ty) {
1243 // Don't report FFI errors for unit return types. This check exists here, and not in
1244 // `check_foreign_fn` (where it would make more sense) so that normalization has definitely
1246 if is_return_type && ty.is_unit() {
1250 match self.check_type_for_ffi(&mut FxHashSet::default(), ty) {
1251 FfiResult::FfiSafe => {}
1252 FfiResult::FfiPhantom(ty) => {
1253 self.emit_ffi_unsafe_type_lint(ty, sp, "composed only of `PhantomData`", None);
1255 // If `ty` is a `repr(transparent)` newtype, and the non-zero-sized type is a generic
1256 // argument, which after substitution, is `()`, then this branch can be hit.
1257 FfiResult::FfiUnsafe { ty, .. } if is_return_type && ty.is_unit() => {}
1258 FfiResult::FfiUnsafe { ty, reason, help } => {
1259 self.emit_ffi_unsafe_type_lint(ty, sp, &reason, help.as_deref());
1264 fn check_foreign_fn(&mut self, id: hir::HirId, decl: &hir::FnDecl<'_>) {
1265 let def_id = self.cx.tcx.hir().local_def_id(id);
1266 let sig = self.cx.tcx.fn_sig(def_id);
1267 let sig = self.cx.tcx.erase_late_bound_regions(sig);
1269 for (input_ty, input_hir) in iter::zip(sig.inputs(), decl.inputs) {
1270 self.check_type_for_ffi_and_report_errors(input_hir.span, *input_ty, false, false);
1273 if let hir::FnRetTy::Return(ref ret_hir) = decl.output {
1274 let ret_ty = sig.output();
1275 self.check_type_for_ffi_and_report_errors(ret_hir.span, ret_ty, false, true);
1279 fn check_foreign_static(&mut self, id: hir::HirId, span: Span) {
1280 let def_id = self.cx.tcx.hir().local_def_id(id);
1281 let ty = self.cx.tcx.type_of(def_id);
1282 self.check_type_for_ffi_and_report_errors(span, ty, true, false);
1285 fn is_internal_abi(&self, abi: SpecAbi) -> bool {
1288 SpecAbi::Rust | SpecAbi::RustCall | SpecAbi::RustIntrinsic | SpecAbi::PlatformIntrinsic
1293 impl<'tcx> LateLintPass<'tcx> for ImproperCTypesDeclarations {
1294 fn check_foreign_item(&mut self, cx: &LateContext<'_>, it: &hir::ForeignItem<'_>) {
1295 let mut vis = ImproperCTypesVisitor { cx, mode: CItemKind::Declaration };
1296 let abi = cx.tcx.hir().get_foreign_abi(it.hir_id());
1298 if !vis.is_internal_abi(abi) {
1300 hir::ForeignItemKind::Fn(ref decl, _, _) => {
1301 vis.check_foreign_fn(it.hir_id(), decl);
1303 hir::ForeignItemKind::Static(ref ty, _) => {
1304 vis.check_foreign_static(it.hir_id(), ty.span);
1306 hir::ForeignItemKind::Type => (),
1312 impl<'tcx> LateLintPass<'tcx> for ImproperCTypesDefinitions {
1315 cx: &LateContext<'tcx>,
1316 kind: hir::intravisit::FnKind<'tcx>,
1317 decl: &'tcx hir::FnDecl<'_>,
1318 _: &'tcx hir::Body<'_>,
1322 use hir::intravisit::FnKind;
1324 let abi = match kind {
1325 FnKind::ItemFn(_, _, header, ..) => header.abi,
1326 FnKind::Method(_, sig, ..) => sig.header.abi,
1330 let mut vis = ImproperCTypesVisitor { cx, mode: CItemKind::Definition };
1331 if !vis.is_internal_abi(abi) {
1332 vis.check_foreign_fn(hir_id, decl);
1337 declare_lint_pass!(VariantSizeDifferences => [VARIANT_SIZE_DIFFERENCES]);
1339 impl<'tcx> LateLintPass<'tcx> for VariantSizeDifferences {
1340 fn check_item(&mut self, cx: &LateContext<'_>, it: &hir::Item<'_>) {
1341 if let hir::ItemKind::Enum(ref enum_definition, _) = it.kind {
1342 let t = cx.tcx.type_of(it.def_id);
1343 let ty = cx.tcx.erase_regions(t);
1344 let Ok(layout) = cx.layout_of(ty) else { return };
1345 let Variants::Multiple {
1346 tag_encoding: TagEncoding::Direct, tag, ref variants, ..
1347 } = &layout.variants else {
1351 let tag_size = tag.size(&cx.tcx).bytes();
1354 "enum `{}` is {} bytes large with layout:\n{:#?}",
1356 layout.size.bytes(),
1360 let (largest, slargest, largest_index) = iter::zip(enum_definition.variants, variants)
1361 .map(|(variant, variant_layout)| {
1362 // Subtract the size of the enum tag.
1363 let bytes = variant_layout.size().bytes().saturating_sub(tag_size);
1365 debug!("- variant `{}` is {} bytes large", variant.ident, bytes);
1369 .fold((0, 0, 0), |(l, s, li), (idx, size)| {
1372 } else if size > s {
1379 // We only warn if the largest variant is at least thrice as large as
1380 // the second-largest.
1381 if largest > slargest * 3 && slargest > 0 {
1382 cx.struct_span_lint(
1383 VARIANT_SIZE_DIFFERENCES,
1384 enum_definition.variants[largest_index].span,
1386 lint.build(&format!(
1387 "enum variant is more than three times \
1388 larger ({} bytes) than the next largest",
1400 /// The `invalid_atomic_ordering` lint detects passing an `Ordering`
1401 /// to an atomic operation that does not support that ordering.
1405 /// ```rust,compile_fail
1406 /// # use core::sync::atomic::{AtomicU8, Ordering};
1407 /// let atom = AtomicU8::new(0);
1408 /// let value = atom.load(Ordering::Release);
1409 /// # let _ = value;
1416 /// Some atomic operations are only supported for a subset of the
1417 /// `atomic::Ordering` variants. Passing an unsupported variant will cause
1418 /// an unconditional panic at runtime, which is detected by this lint.
1420 /// This lint will trigger in the following cases: (where `AtomicType` is an
1421 /// atomic type from `core::sync::atomic`, such as `AtomicBool`,
1422 /// `AtomicPtr`, `AtomicUsize`, or any of the other integer atomics).
1424 /// - Passing `Ordering::Acquire` or `Ordering::AcqRel` to
1425 /// `AtomicType::store`.
1427 /// - Passing `Ordering::Release` or `Ordering::AcqRel` to
1428 /// `AtomicType::load`.
1430 /// - Passing `Ordering::Relaxed` to `core::sync::atomic::fence` or
1431 /// `core::sync::atomic::compiler_fence`.
1433 /// - Passing `Ordering::Release` or `Ordering::AcqRel` as the failure
1434 /// ordering for any of `AtomicType::compare_exchange`,
1435 /// `AtomicType::compare_exchange_weak`, or `AtomicType::fetch_update`.
1437 /// - Passing in a pair of orderings to `AtomicType::compare_exchange`,
1438 /// `AtomicType::compare_exchange_weak`, or `AtomicType::fetch_update`
1439 /// where the failure ordering is stronger than the success ordering.
1440 INVALID_ATOMIC_ORDERING,
1442 "usage of invalid atomic ordering in atomic operations and memory fences"
1445 declare_lint_pass!(InvalidAtomicOrdering => [INVALID_ATOMIC_ORDERING]);
1447 impl InvalidAtomicOrdering {
1448 fn inherent_atomic_method_call<'hir>(
1449 cx: &LateContext<'_>,
1451 recognized_names: &[Symbol], // used for fast path calculation
1452 ) -> Option<(Symbol, &'hir [Expr<'hir>])> {
1453 const ATOMIC_TYPES: &[Symbol] = &[
1469 if let ExprKind::MethodCall(ref method_path, args, _) = &expr.kind
1470 && recognized_names.contains(&method_path.ident.name)
1471 && let Some(m_def_id) = cx.typeck_results().type_dependent_def_id(expr.hir_id)
1472 && let Some(impl_did) = cx.tcx.impl_of_method(m_def_id)
1473 && let Some(adt) = cx.tcx.type_of(impl_did).ty_adt_def()
1474 // skip extension traits, only lint functions from the standard library
1475 && cx.tcx.trait_id_of_impl(impl_did).is_none()
1476 && let parent = cx.tcx.parent(adt.did())
1477 && cx.tcx.is_diagnostic_item(sym::atomic_mod, parent)
1478 && ATOMIC_TYPES.contains(&cx.tcx.item_name(adt.did()))
1480 return Some((method_path.ident.name, args));
1485 fn match_ordering(cx: &LateContext<'_>, ord_arg: &Expr<'_>) -> Option<Symbol> {
1486 let ExprKind::Path(ref ord_qpath) = ord_arg.kind else { return None };
1487 let did = cx.qpath_res(ord_qpath, ord_arg.hir_id).opt_def_id()?;
1489 let atomic_ordering = tcx.get_diagnostic_item(sym::Ordering);
1490 let name = tcx.item_name(did);
1491 let parent = tcx.parent(did);
1492 [sym::Relaxed, sym::Release, sym::Acquire, sym::AcqRel, sym::SeqCst].into_iter().find(
1495 && (Some(parent) == atomic_ordering
1496 // needed in case this is a ctor, not a variant
1497 || tcx.opt_parent(parent) == atomic_ordering)
1502 fn check_atomic_load_store(cx: &LateContext<'_>, expr: &Expr<'_>) {
1503 if let Some((method, args)) = Self::inherent_atomic_method_call(cx, expr, &[sym::load, sym::store])
1504 && let Some((ordering_arg, invalid_ordering)) = match method {
1505 sym::load => Some((&args[1], sym::Release)),
1506 sym::store => Some((&args[2], sym::Acquire)),
1509 && let Some(ordering) = Self::match_ordering(cx, ordering_arg)
1510 && (ordering == invalid_ordering || ordering == sym::AcqRel)
1512 cx.struct_span_lint(INVALID_ATOMIC_ORDERING, ordering_arg.span, |diag| {
1513 if method == sym::load {
1514 diag.build("atomic loads cannot have `Release` or `AcqRel` ordering")
1515 .help("consider using ordering modes `Acquire`, `SeqCst` or `Relaxed`")
1518 debug_assert_eq!(method, sym::store);
1519 diag.build("atomic stores cannot have `Acquire` or `AcqRel` ordering")
1520 .help("consider using ordering modes `Release`, `SeqCst` or `Relaxed`")
1527 fn check_memory_fence(cx: &LateContext<'_>, expr: &Expr<'_>) {
1528 if let ExprKind::Call(ref func, ref args) = expr.kind
1529 && let ExprKind::Path(ref func_qpath) = func.kind
1530 && let Some(def_id) = cx.qpath_res(func_qpath, func.hir_id).opt_def_id()
1531 && matches!(cx.tcx.get_diagnostic_name(def_id), Some(sym::fence | sym::compiler_fence))
1532 && Self::match_ordering(cx, &args[0]) == Some(sym::Relaxed)
1534 cx.struct_span_lint(INVALID_ATOMIC_ORDERING, args[0].span, |diag| {
1535 diag.build("memory fences cannot have `Relaxed` ordering")
1536 .help("consider using ordering modes `Acquire`, `Release`, `AcqRel` or `SeqCst`")
1542 fn check_atomic_compare_exchange(cx: &LateContext<'_>, expr: &Expr<'_>) {
1543 let Some((method, args)) = Self::inherent_atomic_method_call(cx, expr, &[sym::fetch_update, sym::compare_exchange, sym::compare_exchange_weak])
1546 let (success_order_arg, fail_order_arg) = match method {
1547 sym::fetch_update => (&args[1], &args[2]),
1548 sym::compare_exchange | sym::compare_exchange_weak => (&args[3], &args[4]),
1552 let Some(fail_ordering) = Self::match_ordering(cx, fail_order_arg) else { return };
1554 if matches!(fail_ordering, sym::Release | sym::AcqRel) {
1555 cx.struct_span_lint(INVALID_ATOMIC_ORDERING, fail_order_arg.span, |diag| {
1556 diag.build(&format!(
1557 "`{method}`'s failure ordering may not be `Release` or `AcqRel`, \
1558 since a failed `{method}` does not result in a write",
1560 .span_label(fail_order_arg.span, "invalid failure ordering")
1561 .help("consider using `Acquire` or `Relaxed` failure ordering instead")
1566 let Some(success_ordering) = Self::match_ordering(cx, success_order_arg) else { return };
1569 (success_ordering, fail_ordering),
1570 (sym::Relaxed | sym::Release, sym::Acquire)
1571 | (sym::Relaxed | sym::Release | sym::Acquire | sym::AcqRel, sym::SeqCst)
1573 let success_suggestion =
1574 if success_ordering == sym::Release && fail_ordering == sym::Acquire {
1579 cx.struct_span_lint(INVALID_ATOMIC_ORDERING, success_order_arg.span, |diag| {
1580 diag.build(&format!(
1581 "`{method}`'s success ordering must be at least as strong as its failure ordering"
1583 .span_label(fail_order_arg.span, format!("`{fail_ordering}` failure ordering"))
1584 .span_label(success_order_arg.span, format!("`{success_ordering}` success ordering"))
1585 .span_suggestion_short(
1586 success_order_arg.span,
1587 format!("consider using `{success_suggestion}` success ordering instead"),
1588 format!("std::sync::atomic::Ordering::{success_suggestion}"),
1589 Applicability::MaybeIncorrect,
1597 impl<'tcx> LateLintPass<'tcx> for InvalidAtomicOrdering {
1598 fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
1599 Self::check_atomic_load_store(cx, expr);
1600 Self::check_memory_fence(cx, expr);
1601 Self::check_atomic_compare_exchange(cx, expr);