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, ExprKind, Node};
8 use rustc_middle::ty::layout::{IntegerExt, SizeSkeleton};
9 use rustc_middle::ty::subst::SubstsRef;
10 use rustc_middle::ty::{self, AdtKind, Ty, TyCtxt, TypeFoldable};
11 use rustc_span::source_map;
12 use rustc_span::symbol::sym;
13 use rustc_span::{Span, DUMMY_SP};
14 use rustc_target::abi::Abi;
15 use rustc_target::abi::{Integer, LayoutOf, 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 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 crate fn nonnull_optimization_guaranteed<'tcx>(tcx: TyCtxt<'tcx>, def: &ty::AdtDef) -> bool {
670 tcx.get_attrs(def.did)
672 .any(|a| tcx.sess.check_name(a, sym::rustc_nonnull_optimization_guaranteed))
675 /// `repr(transparent)` structs can have a single non-ZST field, this function returns that
677 pub fn transparent_newtype_field<'a, 'tcx>(
679 variant: &'a ty::VariantDef,
680 ) -> Option<&'a ty::FieldDef> {
681 let param_env = tcx.param_env(variant.def_id);
682 variant.fields.iter().find(|field| {
683 let field_ty = tcx.type_of(field.did);
684 let is_zst = tcx.layout_of(param_env.and(field_ty)).map_or(false, |layout| layout.is_zst());
689 /// Is type known to be non-null?
690 fn ty_is_known_nonnull<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>, mode: CItemKind) -> bool {
693 ty::FnPtr(_) => true,
695 ty::Adt(def, _) if def.is_box() && matches!(mode, CItemKind::Definition) => true,
696 ty::Adt(def, substs) if def.repr.transparent() && !def.is_union() => {
697 let marked_non_null = nonnull_optimization_guaranteed(tcx, &def);
703 // Types with a `#[repr(no_niche)]` attribute have their niche hidden.
704 // The attribute is used by the UnsafeCell for example (the only use so far).
705 if def.repr.hide_niche() {
711 .filter_map(|variant| transparent_newtype_field(cx.tcx, variant))
712 .any(|field| ty_is_known_nonnull(cx, field.ty(tcx, substs), mode))
718 /// Given a non-null scalar (or transparent) type `ty`, return the nullable version of that type.
719 /// If the type passed in was not scalar, returns None.
720 fn get_nullable_type<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> Option<Ty<'tcx>> {
722 Some(match *ty.kind() {
723 ty::Adt(field_def, field_substs) => {
724 let inner_field_ty = {
725 let first_non_zst_ty =
726 field_def.variants.iter().filter_map(|v| transparent_newtype_field(cx.tcx, v));
728 first_non_zst_ty.clone().count(),
730 "Wrong number of fields for transparent type"
734 .expect("No non-zst fields in transparent type.")
735 .ty(tcx, field_substs)
737 return get_nullable_type(cx, inner_field_ty);
739 ty::Int(ty) => tcx.mk_mach_int(ty),
740 ty::Uint(ty) => tcx.mk_mach_uint(ty),
741 ty::RawPtr(ty_mut) => tcx.mk_ptr(ty_mut),
742 // As these types are always non-null, the nullable equivalent of
743 // Option<T> of these types are their raw pointer counterparts.
744 ty::Ref(_region, ty, mutbl) => tcx.mk_ptr(ty::TypeAndMut { ty, mutbl }),
746 // There is no nullable equivalent for Rust's function pointers -- you
747 // must use an Option<fn(..) -> _> to represent it.
751 // We should only ever reach this case if ty_is_known_nonnull is extended
755 "get_nullable_type: Unhandled scalar kind: {:?} while checking {:?}",
763 /// Check if this enum can be safely exported based on the "nullable pointer optimization". If it
764 /// can, return the type that `ty` can be safely converted to, otherwise return `None`.
765 /// Currently restricted to function pointers, boxes, references, `core::num::NonZero*`,
766 /// `core::ptr::NonNull`, and `#[repr(transparent)]` newtypes.
767 /// FIXME: This duplicates code in codegen.
768 crate fn repr_nullable_ptr<'tcx>(
769 cx: &LateContext<'tcx>,
772 ) -> Option<Ty<'tcx>> {
773 debug!("is_repr_nullable_ptr(cx, ty = {:?})", ty);
774 if let ty::Adt(ty_def, substs) = ty.kind() {
775 let field_ty = match &ty_def.variants.raw[..] {
776 [var_one, var_two] => match (&var_one.fields[..], &var_two.fields[..]) {
777 ([], [field]) | ([field], []) => field.ty(cx.tcx, substs),
783 if !ty_is_known_nonnull(cx, field_ty, ckind) {
787 // At this point, the field's type is known to be nonnull and the parent enum is Option-like.
788 // If the computed size for the field and the enum are different, the nonnull optimization isn't
789 // being applied (and we've got a problem somewhere).
790 let compute_size_skeleton = |t| SizeSkeleton::compute(t, cx.tcx, cx.param_env).unwrap();
791 if !compute_size_skeleton(ty).same_size(compute_size_skeleton(field_ty)) {
792 bug!("improper_ctypes: Option nonnull optimization not applied?");
795 // Return the nullable type this Option-like enum can be safely represented with.
796 let field_ty_abi = &cx.layout_of(field_ty).unwrap().abi;
797 if let Abi::Scalar(field_ty_scalar) = field_ty_abi {
798 match (field_ty_scalar.valid_range.start(), field_ty_scalar.valid_range.end()) {
799 (0, _) => unreachable!("Non-null optimisation extended to a non-zero value."),
801 return Some(get_nullable_type(cx, field_ty).unwrap());
803 (start, end) => unreachable!("Unhandled start and end range: ({}, {})", start, end),
810 impl<'a, 'tcx> ImproperCTypesVisitor<'a, 'tcx> {
811 /// Check if the type is array and emit an unsafe type lint.
812 fn check_for_array_ty(&mut self, sp: Span, ty: Ty<'tcx>) -> bool {
813 if let ty::Array(..) = ty.kind() {
814 self.emit_ffi_unsafe_type_lint(
817 "passing raw arrays by value is not FFI-safe",
818 Some("consider passing a pointer to the array"),
826 /// Checks if the given field's type is "ffi-safe".
827 fn check_field_type_for_ffi(
829 cache: &mut FxHashSet<Ty<'tcx>>,
830 field: &ty::FieldDef,
831 substs: SubstsRef<'tcx>,
832 ) -> FfiResult<'tcx> {
833 let field_ty = field.ty(self.cx.tcx, substs);
834 if field_ty.has_opaque_types() {
835 self.check_type_for_ffi(cache, field_ty)
837 let field_ty = self.cx.tcx.normalize_erasing_regions(self.cx.param_env, field_ty);
838 self.check_type_for_ffi(cache, field_ty)
842 /// Checks if the given `VariantDef`'s field types are "ffi-safe".
843 fn check_variant_for_ffi(
845 cache: &mut FxHashSet<Ty<'tcx>>,
848 variant: &ty::VariantDef,
849 substs: SubstsRef<'tcx>,
850 ) -> FfiResult<'tcx> {
853 if def.repr.transparent() {
854 // Can assume that only one field is not a ZST, so only check
855 // that field's type for FFI-safety.
856 if let Some(field) = transparent_newtype_field(self.cx.tcx, variant) {
857 self.check_field_type_for_ffi(cache, field, substs)
859 bug!("malformed transparent type");
862 // We can't completely trust repr(C) markings; make sure the fields are
864 let mut all_phantom = !variant.fields.is_empty();
865 for field in &variant.fields {
866 match self.check_field_type_for_ffi(cache, &field, substs) {
870 FfiPhantom(..) if def.is_enum() => {
873 reason: "this enum contains a PhantomData field".into(),
882 if all_phantom { FfiPhantom(ty) } else { FfiSafe }
886 /// Checks if the given type is "ffi-safe" (has a stable, well-defined
887 /// representation which can be exported to C code).
888 fn check_type_for_ffi(&self, cache: &mut FxHashSet<Ty<'tcx>>, ty: Ty<'tcx>) -> FfiResult<'tcx> {
891 let tcx = self.cx.tcx;
893 // Protect against infinite recursion, for example
894 // `struct S(*mut S);`.
895 // FIXME: A recursion limit is necessary as well, for irregular
897 if !cache.insert(ty) {
902 ty::Adt(def, substs) => {
903 if def.is_box() && matches!(self.mode, CItemKind::Definition) {
904 if ty.boxed_ty().is_sized(tcx.at(DUMMY_SP), self.cx.param_env) {
909 reason: "box cannot be represented as a single pointer".to_string(),
914 if def.is_phantom_data() {
915 return FfiPhantom(ty);
917 match def.adt_kind() {
918 AdtKind::Struct | AdtKind::Union => {
919 let kind = if def.is_struct() { "struct" } else { "union" };
921 if !def.repr.c() && !def.repr.transparent() {
924 reason: format!("this {} has unspecified layout", kind),
926 "consider adding a `#[repr(C)]` or \
927 `#[repr(transparent)]` attribute to this {}",
933 let is_non_exhaustive =
934 def.non_enum_variant().is_field_list_non_exhaustive();
935 if is_non_exhaustive && !def.did.is_local() {
938 reason: format!("this {} is non-exhaustive", kind),
943 if def.non_enum_variant().fields.is_empty() {
946 reason: format!("this {} has no fields", kind),
947 help: Some(format!("consider adding a member to this {}", kind)),
951 self.check_variant_for_ffi(cache, ty, def, def.non_enum_variant(), substs)
954 if def.variants.is_empty() {
955 // Empty enums are okay... although sort of useless.
959 // Check for a repr() attribute to specify the size of the
961 if !def.repr.c() && !def.repr.transparent() && def.repr.int.is_none() {
962 // Special-case types like `Option<extern fn()>`.
963 if repr_nullable_ptr(self.cx, ty, self.mode).is_none() {
966 reason: "enum has no representation hint".into(),
968 "consider adding a `#[repr(C)]`, \
969 `#[repr(transparent)]`, or integer `#[repr(...)]` \
970 attribute to this enum"
977 if def.is_variant_list_non_exhaustive() && !def.did.is_local() {
980 reason: "this enum is non-exhaustive".into(),
985 // Check the contained variants.
986 for variant in &def.variants {
987 let is_non_exhaustive = variant.is_field_list_non_exhaustive();
988 if is_non_exhaustive && !variant.def_id.is_local() {
991 reason: "this enum has non-exhaustive variants".into(),
996 match self.check_variant_for_ffi(cache, ty, def, variant, substs) {
1007 ty::Char => FfiUnsafe {
1009 reason: "the `char` type has no C equivalent".into(),
1010 help: Some("consider using `u32` or `libc::wchar_t` instead".into()),
1013 ty::Int(ty::IntTy::I128) | ty::Uint(ty::UintTy::U128) => FfiUnsafe {
1015 reason: "128-bit integers don't currently have a known stable ABI".into(),
1019 // Primitive types with a stable representation.
1020 ty::Bool | ty::Int(..) | ty::Uint(..) | ty::Float(..) | ty::Never => FfiSafe,
1022 ty::Slice(_) => FfiUnsafe {
1024 reason: "slices have no C equivalent".into(),
1025 help: Some("consider using a raw pointer instead".into()),
1028 ty::Dynamic(..) => {
1029 FfiUnsafe { ty, reason: "trait objects have no C equivalent".into(), help: None }
1032 ty::Str => FfiUnsafe {
1034 reason: "string slices have no C equivalent".into(),
1035 help: Some("consider using `*const u8` and a length instead".into()),
1038 ty::Tuple(..) => FfiUnsafe {
1040 reason: "tuples have unspecified layout".into(),
1041 help: Some("consider using a struct instead".into()),
1044 ty::RawPtr(ty::TypeAndMut { ty, .. }) | ty::Ref(_, ty, _)
1046 matches!(self.mode, CItemKind::Definition)
1047 && ty.is_sized(self.cx.tcx.at(DUMMY_SP), self.cx.param_env)
1053 ty::RawPtr(ty::TypeAndMut { ty, .. }) | ty::Ref(_, ty, _) => {
1054 self.check_type_for_ffi(cache, ty)
1057 ty::Array(inner_ty, _) => self.check_type_for_ffi(cache, inner_ty),
1060 if self.is_internal_abi(sig.abi()) {
1063 reason: "this function pointer has Rust-specific calling convention".into(),
1065 "consider using an `extern fn(...) -> ...` \
1066 function pointer instead"
1072 let sig = tcx.erase_late_bound_regions(sig);
1073 if !sig.output().is_unit() {
1074 let r = self.check_type_for_ffi(cache, sig.output());
1082 for arg in sig.inputs() {
1083 let r = self.check_type_for_ffi(cache, arg);
1094 ty::Foreign(..) => FfiSafe,
1096 // While opaque types are checked for earlier, if a projection in a struct field
1097 // normalizes to an opaque type, then it will reach this branch.
1099 FfiUnsafe { ty, reason: "opaque types have no C equivalent".into(), help: None }
1102 // `extern "C" fn` functions can have type parameters, which may or may not be FFI-safe,
1103 // so they are currently ignored for the purposes of this lint.
1104 ty::Param(..) | ty::Projection(..) if matches!(self.mode, CItemKind::Definition) => {
1109 | ty::Projection(..)
1115 | ty::GeneratorWitness(..)
1116 | ty::Placeholder(..)
1117 | ty::FnDef(..) => bug!("unexpected type in foreign function: {:?}", ty),
1121 fn emit_ffi_unsafe_type_lint(
1128 let lint = match self.mode {
1129 CItemKind::Declaration => IMPROPER_CTYPES,
1130 CItemKind::Definition => IMPROPER_CTYPES_DEFINITIONS,
1133 self.cx.struct_span_lint(lint, sp, |lint| {
1134 let item_description = match self.mode {
1135 CItemKind::Declaration => "block",
1136 CItemKind::Definition => "fn",
1138 let mut diag = lint.build(&format!(
1139 "`extern` {} uses type `{}`, which is not FFI-safe",
1140 item_description, ty
1142 diag.span_label(sp, "not FFI-safe");
1143 if let Some(help) = help {
1147 if let ty::Adt(def, _) = ty.kind() {
1148 if let Some(sp) = self.cx.tcx.hir().span_if_local(def.did) {
1149 diag.span_note(sp, "the type is defined here");
1156 fn check_for_opaque_ty(&mut self, sp: Span, ty: Ty<'tcx>) -> bool {
1157 struct ProhibitOpaqueTypes<'a, 'tcx> {
1158 cx: &'a LateContext<'tcx>,
1161 impl<'a, 'tcx> ty::fold::TypeVisitor<'tcx> for ProhibitOpaqueTypes<'a, 'tcx> {
1162 type BreakTy = Ty<'tcx>;
1164 fn visit_ty(&mut self, ty: Ty<'tcx>) -> ControlFlow<Self::BreakTy> {
1166 ty::Opaque(..) => ControlFlow::Break(ty),
1167 // Consider opaque types within projections FFI-safe if they do not normalize
1168 // to more opaque types.
1169 ty::Projection(..) => {
1170 let ty = self.cx.tcx.normalize_erasing_regions(self.cx.param_env, ty);
1172 // If `ty` is a opaque type directly then `super_visit_with` won't invoke
1173 // this function again.
1174 if ty.has_opaque_types() {
1177 ControlFlow::CONTINUE
1180 _ => ty.super_visit_with(self),
1185 if let Some(ty) = ty.visit_with(&mut ProhibitOpaqueTypes { cx: self.cx }).break_value() {
1186 self.emit_ffi_unsafe_type_lint(ty, sp, "opaque types have no C equivalent", None);
1193 fn check_type_for_ffi_and_report_errors(
1198 is_return_type: bool,
1200 // We have to check for opaque types before `normalize_erasing_regions`,
1201 // which will replace opaque types with their underlying concrete type.
1202 if self.check_for_opaque_ty(sp, ty) {
1203 // We've already emitted an error due to an opaque type.
1207 // it is only OK to use this function because extern fns cannot have
1208 // any generic types right now:
1209 let ty = self.cx.tcx.normalize_erasing_regions(self.cx.param_env, ty);
1211 // C doesn't really support passing arrays by value - the only way to pass an array by value
1212 // is through a struct. So, first test that the top level isn't an array, and then
1213 // recursively check the types inside.
1214 if !is_static && self.check_for_array_ty(sp, ty) {
1218 // Don't report FFI errors for unit return types. This check exists here, and not in
1219 // `check_foreign_fn` (where it would make more sense) so that normalization has definitely
1221 if is_return_type && ty.is_unit() {
1225 match self.check_type_for_ffi(&mut FxHashSet::default(), ty) {
1226 FfiResult::FfiSafe => {}
1227 FfiResult::FfiPhantom(ty) => {
1228 self.emit_ffi_unsafe_type_lint(ty, sp, "composed only of `PhantomData`", None);
1230 // If `ty` is a `repr(transparent)` newtype, and the non-zero-sized type is a generic
1231 // argument, which after substitution, is `()`, then this branch can be hit.
1232 FfiResult::FfiUnsafe { ty, .. } if is_return_type && ty.is_unit() => {}
1233 FfiResult::FfiUnsafe { ty, reason, help } => {
1234 self.emit_ffi_unsafe_type_lint(ty, sp, &reason, help.as_deref());
1239 fn check_foreign_fn(&mut self, id: hir::HirId, decl: &hir::FnDecl<'_>) {
1240 let def_id = self.cx.tcx.hir().local_def_id(id);
1241 let sig = self.cx.tcx.fn_sig(def_id);
1242 let sig = self.cx.tcx.erase_late_bound_regions(sig);
1244 for (input_ty, input_hir) in iter::zip(sig.inputs(), decl.inputs) {
1245 self.check_type_for_ffi_and_report_errors(input_hir.span, input_ty, false, false);
1248 if let hir::FnRetTy::Return(ref ret_hir) = decl.output {
1249 let ret_ty = sig.output();
1250 self.check_type_for_ffi_and_report_errors(ret_hir.span, ret_ty, false, true);
1254 fn check_foreign_static(&mut self, id: hir::HirId, span: Span) {
1255 let def_id = self.cx.tcx.hir().local_def_id(id);
1256 let ty = self.cx.tcx.type_of(def_id);
1257 self.check_type_for_ffi_and_report_errors(span, ty, true, false);
1260 fn is_internal_abi(&self, abi: SpecAbi) -> bool {
1263 SpecAbi::Rust | SpecAbi::RustCall | SpecAbi::RustIntrinsic | SpecAbi::PlatformIntrinsic
1268 impl<'tcx> LateLintPass<'tcx> for ImproperCTypesDeclarations {
1269 fn check_foreign_item(&mut self, cx: &LateContext<'_>, it: &hir::ForeignItem<'_>) {
1270 let mut vis = ImproperCTypesVisitor { cx, mode: CItemKind::Declaration };
1271 let abi = cx.tcx.hir().get_foreign_abi(it.hir_id());
1273 if !vis.is_internal_abi(abi) {
1275 hir::ForeignItemKind::Fn(ref decl, _, _) => {
1276 vis.check_foreign_fn(it.hir_id(), decl);
1278 hir::ForeignItemKind::Static(ref ty, _) => {
1279 vis.check_foreign_static(it.hir_id(), ty.span);
1281 hir::ForeignItemKind::Type => (),
1287 impl<'tcx> LateLintPass<'tcx> for ImproperCTypesDefinitions {
1290 cx: &LateContext<'tcx>,
1291 kind: hir::intravisit::FnKind<'tcx>,
1292 decl: &'tcx hir::FnDecl<'_>,
1293 _: &'tcx hir::Body<'_>,
1297 use hir::intravisit::FnKind;
1299 let abi = match kind {
1300 FnKind::ItemFn(_, _, header, ..) => header.abi,
1301 FnKind::Method(_, sig, ..) => sig.header.abi,
1305 let mut vis = ImproperCTypesVisitor { cx, mode: CItemKind::Definition };
1306 if !vis.is_internal_abi(abi) {
1307 vis.check_foreign_fn(hir_id, decl);
1312 declare_lint_pass!(VariantSizeDifferences => [VARIANT_SIZE_DIFFERENCES]);
1314 impl<'tcx> LateLintPass<'tcx> for VariantSizeDifferences {
1315 fn check_item(&mut self, cx: &LateContext<'_>, it: &hir::Item<'_>) {
1316 if let hir::ItemKind::Enum(ref enum_definition, _) = it.kind {
1317 let t = cx.tcx.type_of(it.def_id);
1318 let ty = cx.tcx.erase_regions(t);
1319 let layout = match cx.layout_of(ty) {
1320 Ok(layout) => layout,
1322 ty::layout::LayoutError::Unknown(_) | ty::layout::LayoutError::SizeOverflow(_),
1325 let (variants, tag) = match layout.variants {
1326 Variants::Multiple {
1327 tag_encoding: TagEncoding::Direct,
1331 } => (variants, tag),
1335 let tag_size = tag.value.size(&cx.tcx).bytes();
1338 "enum `{}` is {} bytes large with layout:\n{:#?}",
1340 layout.size.bytes(),
1344 let (largest, slargest, largest_index) = iter::zip(enum_definition.variants, variants)
1345 .map(|(variant, variant_layout)| {
1346 // Subtract the size of the enum tag.
1347 let bytes = variant_layout.size.bytes().saturating_sub(tag_size);
1349 debug!("- variant `{}` is {} bytes large", variant.ident, bytes);
1353 .fold((0, 0, 0), |(l, s, li), (idx, size)| {
1356 } else if size > s {
1363 // We only warn if the largest variant is at least thrice as large as
1364 // the second-largest.
1365 if largest > slargest * 3 && slargest > 0 {
1366 cx.struct_span_lint(
1367 VARIANT_SIZE_DIFFERENCES,
1368 enum_definition.variants[largest_index].span,
1370 lint.build(&format!(
1371 "enum variant is more than three times \
1372 larger ({} bytes) than the next largest",