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::def_id::DefId;
8 use rustc_hir::{is_range_literal, Expr, ExprKind, Node};
9 use rustc_middle::ty::layout::{IntegerExt, SizeSkeleton};
10 use rustc_middle::ty::subst::SubstsRef;
11 use rustc_middle::ty::{self, AdtKind, DefIdTree, Ty, TyCtxt, TypeFoldable};
12 use rustc_span::source_map;
13 use rustc_span::symbol::sym;
14 use rustc_span::{Span, Symbol, DUMMY_SP};
15 use rustc_target::abi::Abi;
16 use rustc_target::abi::{Integer, LayoutOf, TagEncoding, Variants};
17 use rustc_target::spec::abi::Abi as SpecAbi;
19 use if_chain::if_chain;
22 use std::ops::ControlFlow;
26 /// The `unused_comparisons` lint detects comparisons made useless by
27 /// limits of the types involved.
41 /// A useless comparison may indicate a mistake, and should be fixed or
45 "comparisons made useless by limits of the types involved"
49 /// The `overflowing_literals` lint detects literal out of range for its
54 /// ```rust,compile_fail
62 /// It is usually a mistake to use a literal that overflows the type where
63 /// it is used. Either use a literal that is within range, or change the
64 /// type to be within the range of the literal.
67 "literal out of range for its type"
71 /// The `variant_size_differences` lint detects enums with widely varying
76 /// ```rust,compile_fail
77 /// #![deny(variant_size_differences)]
88 /// It can be a mistake to add a variant to an enum that is much larger
89 /// than the other variants, bloating the overall size required for all
90 /// variants. This can impact performance and memory usage. This is
91 /// triggered if one variant is more than 3 times larger than the
92 /// second-largest variant.
94 /// Consider placing the large variant's contents on the heap (for example
95 /// via [`Box`]) to keep the overall size of the enum itself down.
97 /// This lint is "allow" by default because it can be noisy, and may not be
98 /// an actual problem. Decisions about this should be guided with
99 /// profiling and benchmarking.
101 /// [`Box`]: https://doc.rust-lang.org/std/boxed/index.html
102 VARIANT_SIZE_DIFFERENCES,
104 "detects enums with widely varying variant sizes"
107 #[derive(Copy, Clone)]
108 pub struct TypeLimits {
109 /// Id of the last visited negated expression
110 negated_expr_id: Option<hir::HirId>,
113 impl_lint_pass!(TypeLimits => [UNUSED_COMPARISONS, OVERFLOWING_LITERALS]);
116 pub fn new() -> TypeLimits {
117 TypeLimits { negated_expr_id: None }
121 /// Attempts to special-case the overflowing literal lint when it occurs as a range endpoint.
122 /// Returns `true` iff the lint was overridden.
123 fn lint_overflowing_range_endpoint<'tcx>(
124 cx: &LateContext<'tcx>,
128 expr: &'tcx hir::Expr<'tcx>,
129 parent_expr: &'tcx hir::Expr<'tcx>,
132 // We only want to handle exclusive (`..`) ranges,
133 // which are represented as `ExprKind::Struct`.
134 let mut overwritten = false;
135 if let ExprKind::Struct(_, eps, _) = &parent_expr.kind {
139 // We can suggest using an inclusive range
140 // (`..=`) instead only if it is the `end` that is
141 // overflowing and only by 1.
142 if eps[1].expr.hir_id == expr.hir_id && lit_val - 1 == max {
143 cx.struct_span_lint(OVERFLOWING_LITERALS, parent_expr.span, |lint| {
144 let mut err = lint.build(&format!("range endpoint is out of range for `{}`", ty));
145 if let Ok(start) = cx.sess().source_map().span_to_snippet(eps[0].span) {
146 use ast::{LitIntType, LitKind};
147 // We need to preserve the literal's suffix,
148 // as it may determine typing information.
149 let suffix = match lit.node {
150 LitKind::Int(_, LitIntType::Signed(s)) => s.name_str(),
151 LitKind::Int(_, LitIntType::Unsigned(s)) => s.name_str(),
152 LitKind::Int(_, LitIntType::Unsuffixed) => "",
155 let suggestion = format!("{}..={}{}", start, lit_val - 1, suffix);
158 &"use an inclusive range instead",
160 Applicability::MachineApplicable,
171 // For `isize` & `usize`, be conservative with the warnings, so that the
172 // warnings are consistent between 32- and 64-bit platforms.
173 fn int_ty_range(int_ty: ty::IntTy) -> (i128, i128) {
175 ty::IntTy::Isize => (i64::MIN.into(), i64::MAX.into()),
176 ty::IntTy::I8 => (i8::MIN.into(), i8::MAX.into()),
177 ty::IntTy::I16 => (i16::MIN.into(), i16::MAX.into()),
178 ty::IntTy::I32 => (i32::MIN.into(), i32::MAX.into()),
179 ty::IntTy::I64 => (i64::MIN.into(), i64::MAX.into()),
180 ty::IntTy::I128 => (i128::MIN, i128::MAX),
184 fn uint_ty_range(uint_ty: ty::UintTy) -> (u128, u128) {
185 let max = match uint_ty {
186 ty::UintTy::Usize => u64::MAX.into(),
187 ty::UintTy::U8 => u8::MAX.into(),
188 ty::UintTy::U16 => u16::MAX.into(),
189 ty::UintTy::U32 => u32::MAX.into(),
190 ty::UintTy::U64 => u64::MAX.into(),
191 ty::UintTy::U128 => u128::MAX,
196 fn get_bin_hex_repr(cx: &LateContext<'_>, lit: &hir::Lit) -> Option<String> {
197 let src = cx.sess().source_map().span_to_snippet(lit.span).ok()?;
198 let firstch = src.chars().next()?;
201 match src.chars().nth(1) {
202 Some('x' | 'b') => return Some(src),
210 fn report_bin_hex_error(
211 cx: &LateContext<'_>,
212 expr: &hir::Expr<'_>,
218 let size = Integer::from_attr(&cx.tcx, ty).size();
219 cx.struct_span_lint(OVERFLOWING_LITERALS, expr.span, |lint| {
220 let (t, actually) = match ty {
221 attr::IntType::SignedInt(t) => {
222 let actually = if negative {
223 -(size.sign_extend(val) as i128)
225 size.sign_extend(val) as i128
227 (t.name_str(), actually.to_string())
229 attr::IntType::UnsignedInt(t) => {
230 let actually = size.truncate(val);
231 (t.name_str(), actually.to_string())
234 let mut err = lint.build(&format!("literal out of range for `{}`", t));
236 // If the value is negative,
237 // emits a note about the value itself, apart from the literal.
239 "the literal `{}` (decimal `{}`) does not fit into \
243 err.note(&format!("and the value `-{}` will become `{}{}`", repr_str, actually, t));
246 "the literal `{}` (decimal `{}`) does not fit into \
247 the type `{}` and will become `{}{}`",
248 repr_str, val, t, actually, t
251 if let Some(sugg_ty) =
252 get_type_suggestion(&cx.typeck_results().node_type(expr.hir_id), val, negative)
254 if let Some(pos) = repr_str.chars().position(|c| c == 'i' || c == 'u') {
255 let (sans_suffix, _) = repr_str.split_at(pos);
258 &format!("consider using the type `{}` instead", sugg_ty),
259 format!("{}{}", sans_suffix, sugg_ty),
260 Applicability::MachineApplicable,
263 err.help(&format!("consider using the type `{}` instead", sugg_ty));
270 // This function finds the next fitting type and generates a suggestion string.
271 // It searches for fitting types in the following way (`X < Y`):
272 // - `iX`: if literal fits in `uX` => `uX`, else => `iY`
276 // No suggestion for: `isize`, `usize`.
277 fn get_type_suggestion(t: Ty<'_>, val: u128, negative: bool) -> Option<&'static str> {
280 macro_rules! find_fit {
281 ($ty:expr, $val:expr, $negative:expr,
282 $($type:ident => [$($utypes:expr),*] => [$($itypes:expr),*]),+) => {
284 let _neg = if negative { 1 } else { 0 };
287 $(if !negative && val <= uint_ty_range($utypes).1 {
288 return Some($utypes.name_str())
290 $(if val <= int_ty_range($itypes).1 as u128 + _neg {
291 return Some($itypes.name_str())
301 ty::Int(i) => find_fit!(i, val, negative,
302 I8 => [U8] => [I16, I32, I64, I128],
303 I16 => [U16] => [I32, I64, I128],
304 I32 => [U32] => [I64, I128],
305 I64 => [U64] => [I128],
306 I128 => [U128] => []),
307 ty::Uint(u) => find_fit!(u, val, negative,
308 U8 => [U8, U16, U32, U64, U128] => [],
309 U16 => [U16, U32, U64, U128] => [],
310 U32 => [U32, U64, U128] => [],
311 U64 => [U64, U128] => [],
312 U128 => [U128] => []),
317 fn lint_int_literal<'tcx>(
318 cx: &LateContext<'tcx>,
319 type_limits: &TypeLimits,
320 e: &'tcx hir::Expr<'tcx>,
325 let int_type = t.normalize(cx.sess().target.pointer_width);
326 let (min, max) = int_ty_range(int_type);
327 let max = max as u128;
328 let negative = type_limits.negated_expr_id == Some(e.hir_id);
330 // Detect literal value out of range [min, max] inclusive
331 // avoiding use of -min to prevent overflow/panic
332 if (negative && v > max + 1) || (!negative && v > max) {
333 if let Some(repr_str) = get_bin_hex_repr(cx, lit) {
334 report_bin_hex_error(
337 attr::IntType::SignedInt(ty::ast_int_ty(t)),
345 let par_id = cx.tcx.hir().get_parent_node(e.hir_id);
346 if let Node::Expr(par_e) = cx.tcx.hir().get(par_id) {
347 if let hir::ExprKind::Struct(..) = par_e.kind {
348 if is_range_literal(par_e)
349 && lint_overflowing_range_endpoint(cx, lit, v, max, e, par_e, t.name_str())
351 // The overflowing literal lint was overridden.
357 cx.struct_span_lint(OVERFLOWING_LITERALS, e.span, |lint| {
358 let mut err = lint.build(&format!("literal out of range for `{}`", t.name_str()));
360 "the literal `{}` does not fit into the type `{}` whose range is `{}..={}`",
363 .span_to_snippet(lit.span)
364 .expect("must get snippet from literal"),
369 if let Some(sugg_ty) =
370 get_type_suggestion(&cx.typeck_results().node_type(e.hir_id), v, negative)
372 err.help(&format!("consider using the type `{}` instead", sugg_ty));
379 fn lint_uint_literal<'tcx>(
380 cx: &LateContext<'tcx>,
381 e: &'tcx hir::Expr<'tcx>,
385 let uint_type = t.normalize(cx.sess().target.pointer_width);
386 let (min, max) = uint_ty_range(uint_type);
387 let lit_val: u128 = match lit.node {
388 // _v is u8, within range by definition
389 ast::LitKind::Byte(_v) => return,
390 ast::LitKind::Int(v, _) => v,
393 if lit_val < min || lit_val > max {
394 let parent_id = cx.tcx.hir().get_parent_node(e.hir_id);
395 if let Node::Expr(par_e) = cx.tcx.hir().get(parent_id) {
397 hir::ExprKind::Cast(..) => {
398 if let ty::Char = cx.typeck_results().expr_ty(par_e).kind() {
399 cx.struct_span_lint(OVERFLOWING_LITERALS, par_e.span, |lint| {
400 lint.build("only `u8` can be cast into `char`")
403 &"use a `char` literal instead",
404 format!("'\\u{{{:X}}}'", lit_val),
405 Applicability::MachineApplicable,
412 hir::ExprKind::Struct(..) if is_range_literal(par_e) => {
413 let t = t.name_str();
414 if lint_overflowing_range_endpoint(cx, lit, lit_val, max, e, par_e, t) {
415 // The overflowing literal lint was overridden.
422 if let Some(repr_str) = get_bin_hex_repr(cx, lit) {
423 report_bin_hex_error(
426 attr::IntType::UnsignedInt(ty::ast_uint_ty(t)),
433 cx.struct_span_lint(OVERFLOWING_LITERALS, e.span, |lint| {
434 lint.build(&format!("literal out of range for `{}`", t.name_str()))
436 "the literal `{}` does not fit into the type `{}` whose range is `{}..={}`",
439 .span_to_snippet(lit.span)
440 .expect("must get snippet from literal"),
450 fn lint_literal<'tcx>(
451 cx: &LateContext<'tcx>,
452 type_limits: &TypeLimits,
453 e: &'tcx hir::Expr<'tcx>,
456 match *cx.typeck_results().node_type(e.hir_id).kind() {
459 ast::LitKind::Int(v, ast::LitIntType::Signed(_) | ast::LitIntType::Unsuffixed) => {
460 lint_int_literal(cx, type_limits, e, lit, t, v)
465 ty::Uint(t) => lint_uint_literal(cx, e, lit, t),
467 let is_infinite = match lit.node {
468 ast::LitKind::Float(v, _) => match t {
469 ty::FloatTy::F32 => v.as_str().parse().map(f32::is_infinite),
470 ty::FloatTy::F64 => v.as_str().parse().map(f64::is_infinite),
474 if is_infinite == Ok(true) {
475 cx.struct_span_lint(OVERFLOWING_LITERALS, e.span, |lint| {
476 lint.build(&format!("literal out of range for `{}`", t.name_str()))
478 "the literal `{}` does not fit into the type `{}` and will be converted to `{}::INFINITY`",
481 .span_to_snippet(lit.span)
482 .expect("must get snippet from literal"),
494 impl<'tcx> LateLintPass<'tcx> for TypeLimits {
495 fn check_expr(&mut self, cx: &LateContext<'tcx>, e: &'tcx hir::Expr<'tcx>) {
497 hir::ExprKind::Unary(hir::UnOp::Neg, ref expr) => {
498 // propagate negation, if the negation itself isn't negated
499 if self.negated_expr_id != Some(e.hir_id) {
500 self.negated_expr_id = Some(expr.hir_id);
503 hir::ExprKind::Binary(binop, ref l, ref r) => {
504 if is_comparison(binop) && !check_limits(cx, binop, &l, &r) {
505 cx.struct_span_lint(UNUSED_COMPARISONS, e.span, |lint| {
506 lint.build("comparison is useless due to type limits").emit()
510 hir::ExprKind::Lit(ref lit) => lint_literal(cx, self, e, lit),
514 fn is_valid<T: cmp::PartialOrd>(binop: hir::BinOp, v: T, min: T, max: T) -> bool {
516 hir::BinOpKind::Lt => v > min && v <= max,
517 hir::BinOpKind::Le => v >= min && v < max,
518 hir::BinOpKind::Gt => v >= min && v < max,
519 hir::BinOpKind::Ge => v > min && v <= max,
520 hir::BinOpKind::Eq | hir::BinOpKind::Ne => v >= min && v <= max,
525 fn rev_binop(binop: hir::BinOp) -> hir::BinOp {
529 hir::BinOpKind::Lt => hir::BinOpKind::Gt,
530 hir::BinOpKind::Le => hir::BinOpKind::Ge,
531 hir::BinOpKind::Gt => hir::BinOpKind::Lt,
532 hir::BinOpKind::Ge => hir::BinOpKind::Le,
539 cx: &LateContext<'_>,
544 let (lit, expr, swap) = match (&l.kind, &r.kind) {
545 (&hir::ExprKind::Lit(_), _) => (l, r, true),
546 (_, &hir::ExprKind::Lit(_)) => (r, l, false),
549 // Normalize the binop so that the literal is always on the RHS in
551 let norm_binop = if swap { rev_binop(binop) } else { binop };
552 match *cx.typeck_results().node_type(expr.hir_id).kind() {
554 let (min, max) = int_ty_range(int_ty);
555 let lit_val: i128 = match lit.kind {
556 hir::ExprKind::Lit(ref li) => match li.node {
559 ast::LitIntType::Signed(_) | ast::LitIntType::Unsuffixed,
565 is_valid(norm_binop, lit_val, min, max)
567 ty::Uint(uint_ty) => {
568 let (min, max): (u128, u128) = uint_ty_range(uint_ty);
569 let lit_val: u128 = match lit.kind {
570 hir::ExprKind::Lit(ref li) => match li.node {
571 ast::LitKind::Int(v, _) => v,
576 is_valid(norm_binop, lit_val, min, max)
582 fn is_comparison(binop: hir::BinOp) -> bool {
597 /// The `improper_ctypes` lint detects incorrect use of types in foreign
604 /// static STATIC: String;
612 /// The compiler has several checks to verify that types used in `extern`
613 /// blocks are safe and follow certain rules to ensure proper
614 /// compatibility with the foreign interfaces. This lint is issued when it
615 /// detects a probable mistake in a definition. The lint usually should
616 /// provide a description of the issue, along with possibly a hint on how
620 "proper use of libc types in foreign modules"
623 declare_lint_pass!(ImproperCTypesDeclarations => [IMPROPER_CTYPES]);
626 /// The `improper_ctypes_definitions` lint detects incorrect use of
627 /// [`extern` function] definitions.
629 /// [`extern` function]: https://doc.rust-lang.org/reference/items/functions.html#extern-function-qualifier
634 /// # #![allow(unused)]
635 /// pub extern "C" fn str_type(p: &str) { }
642 /// There are many parameter and return types that may be specified in an
643 /// `extern` function that are not compatible with the given ABI. This
644 /// lint is an alert that these types should not be used. The lint usually
645 /// should provide a description of the issue, along with possibly a hint
646 /// on how to resolve it.
647 IMPROPER_CTYPES_DEFINITIONS,
649 "proper use of libc types in foreign item definitions"
652 declare_lint_pass!(ImproperCTypesDefinitions => [IMPROPER_CTYPES_DEFINITIONS]);
654 #[derive(Clone, Copy)]
655 crate enum CItemKind {
660 struct ImproperCTypesVisitor<'a, 'tcx> {
661 cx: &'a LateContext<'tcx>,
665 enum FfiResult<'tcx> {
667 FfiPhantom(Ty<'tcx>),
668 FfiUnsafe { ty: Ty<'tcx>, reason: String, help: Option<String> },
671 crate fn nonnull_optimization_guaranteed<'tcx>(tcx: TyCtxt<'tcx>, def: &ty::AdtDef) -> bool {
672 tcx.get_attrs(def.did)
674 .any(|a| tcx.sess.check_name(a, sym::rustc_nonnull_optimization_guaranteed))
677 /// `repr(transparent)` structs can have a single non-ZST field, this function returns that
679 pub fn transparent_newtype_field<'a, 'tcx>(
681 variant: &'a ty::VariantDef,
682 ) -> Option<&'a ty::FieldDef> {
683 let param_env = tcx.param_env(variant.def_id);
684 variant.fields.iter().find(|field| {
685 let field_ty = tcx.type_of(field.did);
686 let is_zst = tcx.layout_of(param_env.and(field_ty)).map_or(false, |layout| layout.is_zst());
691 /// Is type known to be non-null?
692 fn ty_is_known_nonnull<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>, mode: CItemKind) -> bool {
695 ty::FnPtr(_) => true,
697 ty::Adt(def, _) if def.is_box() && matches!(mode, CItemKind::Definition) => true,
698 ty::Adt(def, substs) if def.repr.transparent() && !def.is_union() => {
699 let marked_non_null = nonnull_optimization_guaranteed(tcx, &def);
705 // Types with a `#[repr(no_niche)]` attribute have their niche hidden.
706 // The attribute is used by the UnsafeCell for example (the only use so far).
707 if def.repr.hide_niche() {
713 .filter_map(|variant| transparent_newtype_field(cx.tcx, variant))
714 .any(|field| ty_is_known_nonnull(cx, field.ty(tcx, substs), mode))
720 /// Given a non-null scalar (or transparent) type `ty`, return the nullable version of that type.
721 /// If the type passed in was not scalar, returns None.
722 fn get_nullable_type<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> Option<Ty<'tcx>> {
724 Some(match *ty.kind() {
725 ty::Adt(field_def, field_substs) => {
726 let inner_field_ty = {
727 let first_non_zst_ty =
728 field_def.variants.iter().filter_map(|v| transparent_newtype_field(cx.tcx, v));
730 first_non_zst_ty.clone().count(),
732 "Wrong number of fields for transparent type"
736 .expect("No non-zst fields in transparent type.")
737 .ty(tcx, field_substs)
739 return get_nullable_type(cx, inner_field_ty);
741 ty::Int(ty) => tcx.mk_mach_int(ty),
742 ty::Uint(ty) => tcx.mk_mach_uint(ty),
743 ty::RawPtr(ty_mut) => tcx.mk_ptr(ty_mut),
744 // As these types are always non-null, the nullable equivalent of
745 // Option<T> of these types are their raw pointer counterparts.
746 ty::Ref(_region, ty, mutbl) => tcx.mk_ptr(ty::TypeAndMut { ty, mutbl }),
748 // There is no nullable equivalent for Rust's function pointers -- you
749 // must use an Option<fn(..) -> _> to represent it.
753 // We should only ever reach this case if ty_is_known_nonnull is extended
757 "get_nullable_type: Unhandled scalar kind: {:?} while checking {:?}",
765 /// Check if this enum can be safely exported based on the "nullable pointer optimization". If it
766 /// can, return the type that `ty` can be safely converted to, otherwise return `None`.
767 /// Currently restricted to function pointers, boxes, references, `core::num::NonZero*`,
768 /// `core::ptr::NonNull`, and `#[repr(transparent)]` newtypes.
769 /// FIXME: This duplicates code in codegen.
770 crate fn repr_nullable_ptr<'tcx>(
771 cx: &LateContext<'tcx>,
774 ) -> Option<Ty<'tcx>> {
775 debug!("is_repr_nullable_ptr(cx, ty = {:?})", ty);
776 if let ty::Adt(ty_def, substs) = ty.kind() {
777 let field_ty = match &ty_def.variants.raw[..] {
778 [var_one, var_two] => match (&var_one.fields[..], &var_two.fields[..]) {
779 ([], [field]) | ([field], []) => field.ty(cx.tcx, substs),
785 if !ty_is_known_nonnull(cx, field_ty, ckind) {
789 // At this point, the field's type is known to be nonnull and the parent enum is Option-like.
790 // If the computed size for the field and the enum are different, the nonnull optimization isn't
791 // being applied (and we've got a problem somewhere).
792 let compute_size_skeleton = |t| SizeSkeleton::compute(t, cx.tcx, cx.param_env).unwrap();
793 if !compute_size_skeleton(ty).same_size(compute_size_skeleton(field_ty)) {
794 bug!("improper_ctypes: Option nonnull optimization not applied?");
797 // Return the nullable type this Option-like enum can be safely represented with.
798 let field_ty_abi = &cx.layout_of(field_ty).unwrap().abi;
799 if let Abi::Scalar(field_ty_scalar) = field_ty_abi {
800 match (field_ty_scalar.valid_range.start(), field_ty_scalar.valid_range.end()) {
801 (0, _) => unreachable!("Non-null optimisation extended to a non-zero value."),
803 return Some(get_nullable_type(cx, field_ty).unwrap());
805 (start, end) => unreachable!("Unhandled start and end range: ({}, {})", start, end),
812 impl<'a, 'tcx> ImproperCTypesVisitor<'a, 'tcx> {
813 /// Check if the type is array and emit an unsafe type lint.
814 fn check_for_array_ty(&mut self, sp: Span, ty: Ty<'tcx>) -> bool {
815 if let ty::Array(..) = ty.kind() {
816 self.emit_ffi_unsafe_type_lint(
819 "passing raw arrays by value is not FFI-safe",
820 Some("consider passing a pointer to the array"),
828 /// Checks if the given field's type is "ffi-safe".
829 fn check_field_type_for_ffi(
831 cache: &mut FxHashSet<Ty<'tcx>>,
832 field: &ty::FieldDef,
833 substs: SubstsRef<'tcx>,
834 ) -> FfiResult<'tcx> {
835 let field_ty = field.ty(self.cx.tcx, substs);
836 if field_ty.has_opaque_types() {
837 self.check_type_for_ffi(cache, field_ty)
839 let field_ty = self.cx.tcx.normalize_erasing_regions(self.cx.param_env, field_ty);
840 self.check_type_for_ffi(cache, field_ty)
844 /// Checks if the given `VariantDef`'s field types are "ffi-safe".
845 fn check_variant_for_ffi(
847 cache: &mut FxHashSet<Ty<'tcx>>,
850 variant: &ty::VariantDef,
851 substs: SubstsRef<'tcx>,
852 ) -> FfiResult<'tcx> {
855 if def.repr.transparent() {
856 // Can assume that only one field is not a ZST, so only check
857 // that field's type for FFI-safety.
858 if let Some(field) = transparent_newtype_field(self.cx.tcx, variant) {
859 self.check_field_type_for_ffi(cache, field, substs)
861 bug!("malformed transparent type");
864 // We can't completely trust repr(C) markings; make sure the fields are
866 let mut all_phantom = !variant.fields.is_empty();
867 for field in &variant.fields {
868 match self.check_field_type_for_ffi(cache, &field, substs) {
872 FfiPhantom(..) if def.is_enum() => {
875 reason: "this enum contains a PhantomData field".into(),
884 if all_phantom { FfiPhantom(ty) } else { FfiSafe }
888 /// Checks if the given type is "ffi-safe" (has a stable, well-defined
889 /// representation which can be exported to C code).
890 fn check_type_for_ffi(&self, cache: &mut FxHashSet<Ty<'tcx>>, ty: Ty<'tcx>) -> FfiResult<'tcx> {
893 let tcx = self.cx.tcx;
895 // Protect against infinite recursion, for example
896 // `struct S(*mut S);`.
897 // FIXME: A recursion limit is necessary as well, for irregular
899 if !cache.insert(ty) {
904 ty::Adt(def, substs) => {
905 if def.is_box() && matches!(self.mode, CItemKind::Definition) {
906 if ty.boxed_ty().is_sized(tcx.at(DUMMY_SP), self.cx.param_env) {
911 reason: "box cannot be represented as a single pointer".to_string(),
916 if def.is_phantom_data() {
917 return FfiPhantom(ty);
919 match def.adt_kind() {
920 AdtKind::Struct | AdtKind::Union => {
921 let kind = if def.is_struct() { "struct" } else { "union" };
923 if !def.repr.c() && !def.repr.transparent() {
926 reason: format!("this {} has unspecified layout", kind),
928 "consider adding a `#[repr(C)]` or \
929 `#[repr(transparent)]` attribute to this {}",
935 let is_non_exhaustive =
936 def.non_enum_variant().is_field_list_non_exhaustive();
937 if is_non_exhaustive && !def.did.is_local() {
940 reason: format!("this {} is non-exhaustive", kind),
945 if def.non_enum_variant().fields.is_empty() {
948 reason: format!("this {} has no fields", kind),
949 help: Some(format!("consider adding a member to this {}", kind)),
953 self.check_variant_for_ffi(cache, ty, def, def.non_enum_variant(), substs)
956 if def.variants.is_empty() {
957 // Empty enums are okay... although sort of useless.
961 // Check for a repr() attribute to specify the size of the
963 if !def.repr.c() && !def.repr.transparent() && def.repr.int.is_none() {
964 // Special-case types like `Option<extern fn()>`.
965 if repr_nullable_ptr(self.cx, ty, self.mode).is_none() {
968 reason: "enum has no representation hint".into(),
970 "consider adding a `#[repr(C)]`, \
971 `#[repr(transparent)]`, or integer `#[repr(...)]` \
972 attribute to this enum"
979 if def.is_variant_list_non_exhaustive() && !def.did.is_local() {
982 reason: "this enum is non-exhaustive".into(),
987 // Check the contained variants.
988 for variant in &def.variants {
989 let is_non_exhaustive = variant.is_field_list_non_exhaustive();
990 if is_non_exhaustive && !variant.def_id.is_local() {
993 reason: "this enum has non-exhaustive variants".into(),
998 match self.check_variant_for_ffi(cache, ty, def, variant, substs) {
1009 ty::Char => FfiUnsafe {
1011 reason: "the `char` type has no C equivalent".into(),
1012 help: Some("consider using `u32` or `libc::wchar_t` instead".into()),
1015 ty::Int(ty::IntTy::I128) | ty::Uint(ty::UintTy::U128) => FfiUnsafe {
1017 reason: "128-bit integers don't currently have a known stable ABI".into(),
1021 // Primitive types with a stable representation.
1022 ty::Bool | ty::Int(..) | ty::Uint(..) | ty::Float(..) | ty::Never => FfiSafe,
1024 ty::Slice(_) => FfiUnsafe {
1026 reason: "slices have no C equivalent".into(),
1027 help: Some("consider using a raw pointer instead".into()),
1030 ty::Dynamic(..) => {
1031 FfiUnsafe { ty, reason: "trait objects have no C equivalent".into(), help: None }
1034 ty::Str => FfiUnsafe {
1036 reason: "string slices have no C equivalent".into(),
1037 help: Some("consider using `*const u8` and a length instead".into()),
1040 ty::Tuple(..) => FfiUnsafe {
1042 reason: "tuples have unspecified layout".into(),
1043 help: Some("consider using a struct instead".into()),
1046 ty::RawPtr(ty::TypeAndMut { ty, .. }) | ty::Ref(_, ty, _)
1048 matches!(self.mode, CItemKind::Definition)
1049 && ty.is_sized(self.cx.tcx.at(DUMMY_SP), self.cx.param_env)
1055 ty::RawPtr(ty::TypeAndMut { ty, .. }) | ty::Ref(_, ty, _) => {
1056 self.check_type_for_ffi(cache, ty)
1059 ty::Array(inner_ty, _) => self.check_type_for_ffi(cache, inner_ty),
1062 if self.is_internal_abi(sig.abi()) {
1065 reason: "this function pointer has Rust-specific calling convention".into(),
1067 "consider using an `extern fn(...) -> ...` \
1068 function pointer instead"
1074 let sig = tcx.erase_late_bound_regions(sig);
1075 if !sig.output().is_unit() {
1076 let r = self.check_type_for_ffi(cache, sig.output());
1084 for arg in sig.inputs() {
1085 let r = self.check_type_for_ffi(cache, arg);
1096 ty::Foreign(..) => FfiSafe,
1098 // While opaque types are checked for earlier, if a projection in a struct field
1099 // normalizes to an opaque type, then it will reach this branch.
1101 FfiUnsafe { ty, reason: "opaque types have no C equivalent".into(), help: None }
1104 // `extern "C" fn` functions can have type parameters, which may or may not be FFI-safe,
1105 // so they are currently ignored for the purposes of this lint.
1106 ty::Param(..) | ty::Projection(..) if matches!(self.mode, CItemKind::Definition) => {
1111 | ty::Projection(..)
1117 | ty::GeneratorWitness(..)
1118 | ty::Placeholder(..)
1119 | ty::FnDef(..) => bug!("unexpected type in foreign function: {:?}", ty),
1123 fn emit_ffi_unsafe_type_lint(
1130 let lint = match self.mode {
1131 CItemKind::Declaration => IMPROPER_CTYPES,
1132 CItemKind::Definition => IMPROPER_CTYPES_DEFINITIONS,
1135 self.cx.struct_span_lint(lint, sp, |lint| {
1136 let item_description = match self.mode {
1137 CItemKind::Declaration => "block",
1138 CItemKind::Definition => "fn",
1140 let mut diag = lint.build(&format!(
1141 "`extern` {} uses type `{}`, which is not FFI-safe",
1142 item_description, ty
1144 diag.span_label(sp, "not FFI-safe");
1145 if let Some(help) = help {
1149 if let ty::Adt(def, _) = ty.kind() {
1150 if let Some(sp) = self.cx.tcx.hir().span_if_local(def.did) {
1151 diag.span_note(sp, "the type is defined here");
1158 fn check_for_opaque_ty(&mut self, sp: Span, ty: Ty<'tcx>) -> bool {
1159 struct ProhibitOpaqueTypes<'a, 'tcx> {
1160 cx: &'a LateContext<'tcx>,
1163 impl<'a, 'tcx> ty::fold::TypeVisitor<'tcx> for ProhibitOpaqueTypes<'a, 'tcx> {
1164 type BreakTy = Ty<'tcx>;
1166 fn visit_ty(&mut self, ty: Ty<'tcx>) -> ControlFlow<Self::BreakTy> {
1168 ty::Opaque(..) => ControlFlow::Break(ty),
1169 // Consider opaque types within projections FFI-safe if they do not normalize
1170 // to more opaque types.
1171 ty::Projection(..) => {
1172 let ty = self.cx.tcx.normalize_erasing_regions(self.cx.param_env, ty);
1174 // If `ty` is a opaque type directly then `super_visit_with` won't invoke
1175 // this function again.
1176 if ty.has_opaque_types() {
1179 ControlFlow::CONTINUE
1182 _ => ty.super_visit_with(self),
1187 if let Some(ty) = ty.visit_with(&mut ProhibitOpaqueTypes { cx: self.cx }).break_value() {
1188 self.emit_ffi_unsafe_type_lint(ty, sp, "opaque types have no C equivalent", None);
1195 fn check_type_for_ffi_and_report_errors(
1200 is_return_type: bool,
1202 // We have to check for opaque types before `normalize_erasing_regions`,
1203 // which will replace opaque types with their underlying concrete type.
1204 if self.check_for_opaque_ty(sp, ty) {
1205 // We've already emitted an error due to an opaque type.
1209 // it is only OK to use this function because extern fns cannot have
1210 // any generic types right now:
1211 let ty = self.cx.tcx.normalize_erasing_regions(self.cx.param_env, ty);
1213 // C doesn't really support passing arrays by value - the only way to pass an array by value
1214 // is through a struct. So, first test that the top level isn't an array, and then
1215 // recursively check the types inside.
1216 if !is_static && self.check_for_array_ty(sp, ty) {
1220 // Don't report FFI errors for unit return types. This check exists here, and not in
1221 // `check_foreign_fn` (where it would make more sense) so that normalization has definitely
1223 if is_return_type && ty.is_unit() {
1227 match self.check_type_for_ffi(&mut FxHashSet::default(), ty) {
1228 FfiResult::FfiSafe => {}
1229 FfiResult::FfiPhantom(ty) => {
1230 self.emit_ffi_unsafe_type_lint(ty, sp, "composed only of `PhantomData`", None);
1232 // If `ty` is a `repr(transparent)` newtype, and the non-zero-sized type is a generic
1233 // argument, which after substitution, is `()`, then this branch can be hit.
1234 FfiResult::FfiUnsafe { ty, .. } if is_return_type && ty.is_unit() => {}
1235 FfiResult::FfiUnsafe { ty, reason, help } => {
1236 self.emit_ffi_unsafe_type_lint(ty, sp, &reason, help.as_deref());
1241 fn check_foreign_fn(&mut self, id: hir::HirId, decl: &hir::FnDecl<'_>) {
1242 let def_id = self.cx.tcx.hir().local_def_id(id);
1243 let sig = self.cx.tcx.fn_sig(def_id);
1244 let sig = self.cx.tcx.erase_late_bound_regions(sig);
1246 for (input_ty, input_hir) in iter::zip(sig.inputs(), decl.inputs) {
1247 self.check_type_for_ffi_and_report_errors(input_hir.span, input_ty, false, false);
1250 if let hir::FnRetTy::Return(ref ret_hir) = decl.output {
1251 let ret_ty = sig.output();
1252 self.check_type_for_ffi_and_report_errors(ret_hir.span, ret_ty, false, true);
1256 fn check_foreign_static(&mut self, id: hir::HirId, span: Span) {
1257 let def_id = self.cx.tcx.hir().local_def_id(id);
1258 let ty = self.cx.tcx.type_of(def_id);
1259 self.check_type_for_ffi_and_report_errors(span, ty, true, false);
1262 fn is_internal_abi(&self, abi: SpecAbi) -> bool {
1265 SpecAbi::Rust | SpecAbi::RustCall | SpecAbi::RustIntrinsic | SpecAbi::PlatformIntrinsic
1270 impl<'tcx> LateLintPass<'tcx> for ImproperCTypesDeclarations {
1271 fn check_foreign_item(&mut self, cx: &LateContext<'_>, it: &hir::ForeignItem<'_>) {
1272 let mut vis = ImproperCTypesVisitor { cx, mode: CItemKind::Declaration };
1273 let abi = cx.tcx.hir().get_foreign_abi(it.hir_id());
1275 if !vis.is_internal_abi(abi) {
1277 hir::ForeignItemKind::Fn(ref decl, _, _) => {
1278 vis.check_foreign_fn(it.hir_id(), decl);
1280 hir::ForeignItemKind::Static(ref ty, _) => {
1281 vis.check_foreign_static(it.hir_id(), ty.span);
1283 hir::ForeignItemKind::Type => (),
1289 impl<'tcx> LateLintPass<'tcx> for ImproperCTypesDefinitions {
1292 cx: &LateContext<'tcx>,
1293 kind: hir::intravisit::FnKind<'tcx>,
1294 decl: &'tcx hir::FnDecl<'_>,
1295 _: &'tcx hir::Body<'_>,
1299 use hir::intravisit::FnKind;
1301 let abi = match kind {
1302 FnKind::ItemFn(_, _, header, ..) => header.abi,
1303 FnKind::Method(_, sig, ..) => sig.header.abi,
1307 let mut vis = ImproperCTypesVisitor { cx, mode: CItemKind::Definition };
1308 if !vis.is_internal_abi(abi) {
1309 vis.check_foreign_fn(hir_id, decl);
1314 declare_lint_pass!(VariantSizeDifferences => [VARIANT_SIZE_DIFFERENCES]);
1316 impl<'tcx> LateLintPass<'tcx> for VariantSizeDifferences {
1317 fn check_item(&mut self, cx: &LateContext<'_>, it: &hir::Item<'_>) {
1318 if let hir::ItemKind::Enum(ref enum_definition, _) = it.kind {
1319 let t = cx.tcx.type_of(it.def_id);
1320 let ty = cx.tcx.erase_regions(t);
1321 let layout = match cx.layout_of(ty) {
1322 Ok(layout) => layout,
1324 ty::layout::LayoutError::Unknown(_) | ty::layout::LayoutError::SizeOverflow(_),
1327 let (variants, tag) = match layout.variants {
1328 Variants::Multiple {
1329 tag_encoding: TagEncoding::Direct,
1333 } => (variants, tag),
1337 let tag_size = tag.value.size(&cx.tcx).bytes();
1340 "enum `{}` is {} bytes large with layout:\n{:#?}",
1342 layout.size.bytes(),
1346 let (largest, slargest, largest_index) = iter::zip(enum_definition.variants, variants)
1347 .map(|(variant, variant_layout)| {
1348 // Subtract the size of the enum tag.
1349 let bytes = variant_layout.size.bytes().saturating_sub(tag_size);
1351 debug!("- variant `{}` is {} bytes large", variant.ident, bytes);
1355 .fold((0, 0, 0), |(l, s, li), (idx, size)| {
1358 } else if size > s {
1365 // We only warn if the largest variant is at least thrice as large as
1366 // the second-largest.
1367 if largest > slargest * 3 && slargest > 0 {
1368 cx.struct_span_lint(
1369 VARIANT_SIZE_DIFFERENCES,
1370 enum_definition.variants[largest_index].span,
1372 lint.build(&format!(
1373 "enum variant is more than three times \
1374 larger ({} bytes) than the next largest",
1386 /// The `invalid_atomic_ordering` lint detects passing an `Ordering`
1387 /// to an atomic operation that does not support that ordering.
1391 /// ```rust,compile_fail
1392 /// # use core::sync::atomic::{AtomicU8, Ordering};
1393 /// let atom = AtomicU8::new(0);
1394 /// let value = atom.load(Ordering::Release);
1395 /// # let _ = value;
1402 /// Some atomic operations are only supported for a subset of the
1403 /// `atomic::Ordering` variants. Passing an unsupported variant will cause
1404 /// an unconditional panic at runtime, which is detected by this lint.
1406 /// This lint will trigger in the following cases: (where `AtomicType` is an
1407 /// atomic type from `core::sync::atomic`, such as `AtomicBool`,
1408 /// `AtomicPtr`, `AtomicUsize`, or any of the other integer atomics).
1410 /// - Passing `Ordering::Acquire` or `Ordering::AcqRel` to
1411 /// `AtomicType::store`.
1413 /// - Passing `Ordering::Release` or `Ordering::AcqRel` to
1414 /// `AtomicType::load`.
1416 /// - Passing `Ordering::Relaxed` to `core::sync::atomic::fence` or
1417 /// `core::sync::atomic::compiler_fence`.
1419 /// - Passing `Ordering::Release` or `Ordering::AcqRel` as the failure
1420 /// ordering for any of `AtomicType::compare_exchange`,
1421 /// `AtomicType::compare_exchange_weak`, or `AtomicType::fetch_update`.
1423 /// - Passing in a pair of orderings to `AtomicType::compare_exchange`,
1424 /// `AtomicType::compare_exchange_weak`, or `AtomicType::fetch_update`
1425 /// where the failure ordering is stronger than the success ordering.
1426 INVALID_ATOMIC_ORDERING,
1428 "usage of invalid atomic ordering in atomic operations and memory fences"
1431 declare_lint_pass!(InvalidAtomicOrdering => [INVALID_ATOMIC_ORDERING]);
1433 impl InvalidAtomicOrdering {
1434 fn inherent_atomic_method_call<'hir>(
1435 cx: &LateContext<'_>,
1437 recognized_names: &[Symbol], // used for fast path calculation
1438 ) -> Option<(Symbol, &'hir [Expr<'hir>])> {
1439 const ATOMIC_TYPES: &[Symbol] = &[
1456 if let ExprKind::MethodCall(ref method_path, _, args, _) = &expr.kind;
1457 if recognized_names.contains(&method_path.ident.name);
1458 if let Some(m_def_id) = cx.typeck_results().type_dependent_def_id(expr.hir_id);
1459 if let Some(impl_did) = cx.tcx.impl_of_method(m_def_id);
1460 if let Some(adt) = cx.tcx.type_of(impl_did).ty_adt_def();
1461 // skip extension traits, only lint functions from the standard library
1462 if cx.tcx.trait_id_of_impl(impl_did).is_none();
1464 if let Some(parent) = cx.tcx.parent(adt.did);
1465 if cx.tcx.is_diagnostic_item(sym::atomic_mod, parent);
1466 if ATOMIC_TYPES.contains(&cx.tcx.item_name(adt.did));
1468 return Some((method_path.ident.name, args));
1474 fn matches_ordering(cx: &LateContext<'_>, did: DefId, orderings: &[Symbol]) -> bool {
1476 let atomic_ordering = tcx.get_diagnostic_item(sym::Ordering);
1477 orderings.iter().any(|ordering| {
1478 tcx.item_name(did) == *ordering && {
1479 let parent = tcx.parent(did);
1480 parent == atomic_ordering
1481 // needed in case this is a ctor, not a variant
1482 || parent.map_or(false, |parent| tcx.parent(parent) == atomic_ordering)
1487 fn opt_ordering_defid(cx: &LateContext<'_>, ord_arg: &Expr<'_>) -> Option<DefId> {
1488 if let ExprKind::Path(ref ord_qpath) = ord_arg.kind {
1489 cx.qpath_res(ord_qpath, ord_arg.hir_id).opt_def_id()
1495 fn check_atomic_load_store(cx: &LateContext<'_>, expr: &Expr<'_>) {
1496 use rustc_hir::def::{DefKind, Res};
1497 use rustc_hir::QPath;
1499 if let Some((method, args)) = Self::inherent_atomic_method_call(cx, expr, &[sym::load, sym::store]);
1500 if let Some((ordering_arg, invalid_ordering)) = match method {
1501 sym::load => Some((&args[1], sym::Release)),
1502 sym::store => Some((&args[2], sym::Acquire)),
1506 if let ExprKind::Path(QPath::Resolved(_, path)) = ordering_arg.kind;
1507 if let Res::Def(DefKind::Ctor(..), ctor_id) = path.res;
1508 if Self::matches_ordering(cx, ctor_id, &[invalid_ordering, sym::AcqRel]);
1510 cx.struct_span_lint(INVALID_ATOMIC_ORDERING, ordering_arg.span, |diag| {
1511 if method == sym::load {
1512 diag.build("atomic loads cannot have `Release` or `AcqRel` ordering")
1513 .help("consider using ordering modes `Acquire`, `SeqCst` or `Relaxed`")
1516 debug_assert_eq!(method, sym::store);
1517 diag.build("atomic stores cannot have `Acquire` or `AcqRel` ordering")
1518 .help("consider using ordering modes `Release`, `SeqCst` or `Relaxed`")
1526 fn check_memory_fence(cx: &LateContext<'_>, expr: &Expr<'_>) {
1528 if let ExprKind::Call(ref func, ref args) = expr.kind;
1529 if let ExprKind::Path(ref func_qpath) = func.kind;
1530 if let Some(def_id) = cx.qpath_res(func_qpath, func.hir_id).opt_def_id();
1531 if cx.tcx.is_diagnostic_item(sym::fence, def_id) ||
1532 cx.tcx.is_diagnostic_item(sym::compiler_fence, def_id);
1533 if let ExprKind::Path(ref ordering_qpath) = &args[0].kind;
1534 if let Some(ordering_def_id) = cx.qpath_res(ordering_qpath, args[0].hir_id).opt_def_id();
1535 if Self::matches_ordering(cx, ordering_def_id, &[sym::Relaxed]);
1537 cx.struct_span_lint(INVALID_ATOMIC_ORDERING, args[0].span, |diag| {
1538 diag.build("memory fences cannot have `Relaxed` ordering")
1539 .help("consider using ordering modes `Acquire`, `Release`, `AcqRel` or `SeqCst`")
1546 fn check_atomic_compare_exchange(cx: &LateContext<'_>, expr: &Expr<'_>) {
1548 if let Some((method, args)) = Self::inherent_atomic_method_call(cx, expr, &[sym::fetch_update, sym::compare_exchange, sym::compare_exchange_weak]);
1549 if let Some((success_order_arg, failure_order_arg)) = match method {
1550 sym::fetch_update => Some((&args[1], &args[2])),
1551 sym::compare_exchange | sym::compare_exchange_weak => Some((&args[3], &args[4])),
1555 if let Some(fail_ordering_def_id) = Self::opt_ordering_defid(cx, failure_order_arg);
1557 // Helper type holding on to some checking and error reporting data. Has
1558 // - (success ordering,
1559 // - list of failure orderings forbidden by the success order,
1560 // - suggestion message)
1561 type OrdLintInfo = (Symbol, &'static [Symbol], &'static str);
1562 const RELAXED: OrdLintInfo = (sym::Relaxed, &[sym::SeqCst, sym::Acquire], "ordering mode `Relaxed`");
1563 const ACQUIRE: OrdLintInfo = (sym::Acquire, &[sym::SeqCst], "ordering modes `Acquire` or `Relaxed`");
1564 const SEQ_CST: OrdLintInfo = (sym::SeqCst, &[], "ordering modes `Acquire`, `SeqCst` or `Relaxed`");
1565 const RELEASE: OrdLintInfo = (sym::Release, RELAXED.1, RELAXED.2);
1566 const ACQREL: OrdLintInfo = (sym::AcqRel, ACQUIRE.1, ACQUIRE.2);
1567 const SEARCH: [OrdLintInfo; 5] = [RELAXED, ACQUIRE, SEQ_CST, RELEASE, ACQREL];
1569 let success_lint_info = Self::opt_ordering_defid(cx, success_order_arg)
1570 .and_then(|success_ord_def_id| -> Option<OrdLintInfo> {
1574 .find(|(ordering, ..)| {
1575 Self::matches_ordering(cx, success_ord_def_id, &[*ordering])
1578 if Self::matches_ordering(cx, fail_ordering_def_id, &[sym::Release, sym::AcqRel]) {
1579 // If we don't know the success order is, use what we'd suggest
1580 // if it were maximally permissive.
1581 let suggested = success_lint_info.unwrap_or(SEQ_CST).2;
1582 cx.struct_span_lint(INVALID_ATOMIC_ORDERING, failure_order_arg.span, |diag| {
1584 "{}'s failure ordering may not be `Release` or `AcqRel`",
1588 .help(&format!("consider using {} instead", suggested))
1591 } else if let Some((success_ord, bad_ords_given_success, suggested)) = success_lint_info {
1592 if Self::matches_ordering(cx, fail_ordering_def_id, bad_ords_given_success) {
1593 cx.struct_span_lint(INVALID_ATOMIC_ORDERING, failure_order_arg.span, |diag| {
1595 "{}'s failure ordering may not be stronger than the success ordering of `{}`",
1600 .help(&format!("consider using {} instead", suggested))
1610 impl<'tcx> LateLintPass<'tcx> for InvalidAtomicOrdering {
1611 fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
1612 Self::check_atomic_load_store(cx, expr);
1613 Self::check_memory_fence(cx, expr);
1614 Self::check_atomic_compare_exchange(cx, expr);