compiler/rustc_lint/src/types.rs

   1 use crate::{LateContext, LateLintPass, LintContext};
   2 use rustc_ast as ast;
   3 use rustc_attr as attr;
   4 use rustc_data_structures::fx::FxHashSet;
   5 use rustc_errors::Applicability;
   6 use rustc_hir as hir;
   7 use rustc_hir::{is_range_literal, ExprKind, Node};
   8 use rustc_index::vec::Idx;
   9 use rustc_middle::ty::layout::{IntegerExt, SizeSkeleton};
  10 use rustc_middle::ty::subst::SubstsRef;
  11 use rustc_middle::ty::{self, AdtKind, Ty, TyCtxt, TypeFoldable};
  12 use rustc_span::source_map;
  13 use rustc_span::symbol::sym;
  14 use rustc_span::{Span, DUMMY_SP};
  15 use rustc_target::abi::Abi;
  16 use rustc_target::abi::{Integer, LayoutOf, TagEncoding, VariantIdx, Variants};
  17 use rustc_target::spec::abi::Abi as SpecAbi;
  18
  19 use std::cmp;
  20 use std::ops::ControlFlow;
  21 use tracing::debug;
  22
  23 declare_lint! {
  24     /// The `unused_comparisons` lint detects comparisons made useless by
  25     /// limits of the types involved.
  26     ///
  27     /// ### Example
  28     ///
  29     /// ```rust
  30     /// fn foo(x: u8) {
  31     ///     x >= 0;
  32     /// }
  33     /// ```
  34     ///
  35     /// {{produces}}
  36     ///
  37     /// ### Explanation
  38     ///
  39     /// A useless comparison may indicate a mistake, and should be fixed or
  40     /// removed.
  41     UNUSED_COMPARISONS,
  42     Warn,
  43     "comparisons made useless by limits of the types involved"
  44 }
  45
  46 declare_lint! {
  47     /// The `overflowing_literals` lint detects literal out of range for its
  48     /// type.
  49     ///
  50     /// ### Example
  51     ///
  52     /// ```rust,compile_fail
  53     /// let x: u8 = 1000;
  54     /// ```
  55     ///
  56     /// {{produces}}
  57     ///
  58     /// ### Explanation
  59     ///
  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.
  63     OVERFLOWING_LITERALS,
  64     Deny,
  65     "literal out of range for its type"
  66 }
  67
  68 declare_lint! {
  69     /// The `variant_size_differences` lint detects enums with widely varying
  70     /// variant sizes.
  71     ///
  72     /// ### Example
  73     ///
  74     /// ```rust,compile_fail
  75     /// #![deny(variant_size_differences)]
  76     /// enum En {
  77     ///     V0(u8),
  78     ///     VBig([u8; 1024]),
  79     /// }
  80     /// ```
  81     ///
  82     /// {{produces}}
  83     ///
  84     /// ### Explanation
  85     ///
  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.
  91     ///
  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.
  94     ///
  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.
  98     ///
  99     /// [`Box`]: https://doc.rust-lang.org/std/boxed/index.html
 100     VARIANT_SIZE_DIFFERENCES,
 101     Allow,
 102     "detects enums with widely varying variant sizes"
 103 }
 104
 105 #[derive(Copy, Clone)]
 106 pub struct TypeLimits {
 107     /// Id of the last visited negated expression
 108     negated_expr_id: Option<hir::HirId>,
 109 }
 110
 111 impl_lint_pass!(TypeLimits => [UNUSED_COMPARISONS, OVERFLOWING_LITERALS]);
 112
 113 impl TypeLimits {
 114     pub fn new() -> TypeLimits {
 115         TypeLimits { negated_expr_id: None }
 116     }
 117 }
 118
 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>,
 123     lit: &hir::Lit,
 124     lit_val: u128,
 125     max: u128,
 126     expr: &'tcx hir::Expr<'tcx>,
 127     parent_expr: &'tcx hir::Expr<'tcx>,
 128     ty: &str,
 129 ) -> bool {
 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 {
 134         if eps.len() != 2 {
 135             return false;
 136         }
 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) => "",
 151                         _ => bug!(),
 152                     };
 153                     let suggestion = format!("{}..={}{}", start, lit_val - 1, suffix);
 154                     err.span_suggestion(
 155                         parent_expr.span,
 156                         &"use an inclusive range instead",
 157                         suggestion,
 158                         Applicability::MachineApplicable,
 159                     );
 160                     err.emit();
 161                     overwritten = true;
 162                 }
 163             });
 164         }
 165     }
 166     overwritten
 167 }
 168
 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) {
 172     match int_ty {
 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),
 179     }
 180 }
 181
 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,
 190     };
 191     (0, max)
 192 }
 193
 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()?;
 197
 198     if firstch == '0' {
 199         match src.chars().nth(1) {
 200             Some('x' | 'b') => return Some(src),
 201             _ => return None,
 202         }
 203     }
 204
 205     None
 206 }
 207
 208 fn report_bin_hex_error(
 209     cx: &LateContext<'_>,
 210     expr: &hir::Expr<'_>,
 211     ty: attr::IntType,
 212     repr_str: String,
 213     val: u128,
 214     negative: bool,
 215 ) {
 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)
 222                 } else {
 223                     size.sign_extend(val) as i128
 224                 };
 225                 (t.name_str(), actually.to_string())
 226             }
 227             attr::IntType::UnsignedInt(t) => {
 228                 let actually = size.truncate(val);
 229                 (t.name_str(), actually.to_string())
 230             }
 231         };
 232         let mut err = lint.build(&format!("literal out of range for `{}`", t));
 233         if negative {
 234             // If the value is negative,
 235             // emits a note about the value itself, apart from the literal.
 236             err.note(&format!(
 237                 "the literal `{}` (decimal `{}`) does not fit into \
 238                  the type `{}`",
 239                 repr_str, val, t
 240             ));
 241             err.note(&format!("and the value `-{}` will become `{}{}`", repr_str, actually, t));
 242         } else {
 243             err.note(&format!(
 244                 "the literal `{}` (decimal `{}`) does not fit into \
 245                  the type `{}` and will become `{}{}`",
 246                 repr_str, val, t, actually, t
 247             ));
 248         }
 249         if let Some(sugg_ty) =
 250             get_type_suggestion(&cx.typeck_results().node_type(expr.hir_id), val, negative)
 251         {
 252             if let Some(pos) = repr_str.chars().position(|c| c == 'i' || c == 'u') {
 253                 let (sans_suffix, _) = repr_str.split_at(pos);
 254                 err.span_suggestion(
 255                     expr.span,
 256                     &format!("consider using the type `{}` instead", sugg_ty),
 257                     format!("{}{}", sans_suffix, sugg_ty),
 258                     Applicability::MachineApplicable,
 259                 );
 260             } else {
 261                 err.help(&format!("consider using the type `{}` instead", sugg_ty));
 262             }
 263         }
 264         err.emit();
 265     });
 266 }
 267
 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`
 271 //  - `-iX` => `iY`
 272 //  - `uX` => `uY`
 273 //
 274 // No suggestion for: `isize`, `usize`.
 275 fn get_type_suggestion(t: Ty<'_>, val: u128, negative: bool) -> Option<&'static str> {
 276     use ty::IntTy::*;
 277     use ty::UintTy::*;
 278     macro_rules! find_fit {
 279         ($ty:expr, $val:expr, $negative:expr,
 280          $($type:ident => [$($utypes:expr),*] => [$($itypes:expr),*]),+) => {
 281             {
 282                 let _neg = if negative { 1 } else { 0 };
 283                 match $ty {
 284                     $($type => {
 285                         $(if !negative && val <= uint_ty_range($utypes).1 {
 286                             return Some($utypes.name_str())
 287                         })*
 288                         $(if val <= int_ty_range($itypes).1 as u128 + _neg {
 289                             return Some($itypes.name_str())
 290                         })*
 291                         None
 292                     },)+
 293                     _ => None
 294                 }
 295             }
 296         }
 297     }
 298     match t.kind() {
 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] => []),
 311         _ => None,
 312     }
 313 }
 314
 315 fn lint_int_literal<'tcx>(
 316     cx: &LateContext<'tcx>,
 317     type_limits: &TypeLimits,
 318     e: &'tcx hir::Expr<'tcx>,
 319     lit: &hir::Lit,
 320     t: ty::IntTy,
 321     v: u128,
 322 ) {
 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);
 327
 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(
 333                 cx,
 334                 e,
 335                 attr::IntType::SignedInt(ty::ast_int_ty(t)),
 336                 repr_str,
 337                 v,
 338                 negative,
 339             );
 340             return;
 341         }
 342
 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())
 348                 {
 349                     // The overflowing literal lint was overridden.
 350                     return;
 351                 }
 352             }
 353         }
 354
 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()));
 357             err.note(&format!(
 358                 "the literal `{}` does not fit into the type `{}` whose range is `{}..={}`",
 359                 cx.sess()
 360                     .source_map()
 361                     .span_to_snippet(lit.span)
 362                     .expect("must get snippet from literal"),
 363                 t.name_str(),
 364                 min,
 365                 max,
 366             ));
 367             if let Some(sugg_ty) =
 368                 get_type_suggestion(&cx.typeck_results().node_type(e.hir_id), v, negative)
 369             {
 370                 err.help(&format!("consider using the type `{}` instead", sugg_ty));
 371             }
 372             err.emit();
 373         });
 374     }
 375 }
 376
 377 fn lint_uint_literal<'tcx>(
 378     cx: &LateContext<'tcx>,
 379     e: &'tcx hir::Expr<'tcx>,
 380     lit: &hir::Lit,
 381     t: ty::UintTy,
 382 ) {
 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,
 389         _ => bug!(),
 390     };
 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) {
 394             match par_e.kind {
 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`")
 399                                 .span_suggestion(
 400                                     par_e.span,
 401                                     &"use a `char` literal instead",
 402                                     format!("'\\u{{{:X}}}'", lit_val),
 403                                     Applicability::MachineApplicable,
 404                                 )
 405                                 .emit();
 406                         });
 407                         return;
 408                     }
 409                 }
 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.
 414                         return;
 415                     }
 416                 }
 417                 _ => {}
 418             }
 419         }
 420         if let Some(repr_str) = get_bin_hex_repr(cx, lit) {
 421             report_bin_hex_error(
 422                 cx,
 423                 e,
 424                 attr::IntType::UnsignedInt(ty::ast_uint_ty(t)),
 425                 repr_str,
 426                 lit_val,
 427                 false,
 428             );
 429             return;
 430         }
 431         cx.struct_span_lint(OVERFLOWING_LITERALS, e.span, |lint| {
 432             lint.build(&format!("literal out of range for `{}`", t.name_str()))
 433                 .note(&format!(
 434                     "the literal `{}` does not fit into the type `{}` whose range is `{}..={}`",
 435                     cx.sess()
 436                         .source_map()
 437                         .span_to_snippet(lit.span)
 438                         .expect("must get snippet from literal"),
 439                     t.name_str(),
 440                     min,
 441                     max,
 442                 ))
 443                 .emit()
 444         });
 445     }
 446 }
 447
 448 fn lint_literal<'tcx>(
 449     cx: &LateContext<'tcx>,
 450     type_limits: &TypeLimits,
 451     e: &'tcx hir::Expr<'tcx>,
 452     lit: &hir::Lit,
 453 ) {
 454     match *cx.typeck_results().node_type(e.hir_id).kind() {
 455         ty::Int(t) => {
 456             match lit.node {
 457                 ast::LitKind::Int(v, ast::LitIntType::Signed(_) | ast::LitIntType::Unsuffixed) => {
 458                     lint_int_literal(cx, type_limits, e, lit, t, v)
 459                 }
 460                 _ => bug!(),
 461             };
 462         }
 463         ty::Uint(t) => lint_uint_literal(cx, e, lit, t),
 464         ty::Float(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),
 469                 },
 470                 _ => bug!(),
 471             };
 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()))
 475                         .note(&format!(
 476                             "the literal `{}` does not fit into the type `{}` and will be converted to `{}::INFINITY`",
 477                             cx.sess()
 478                                 .source_map()
 479                                 .span_to_snippet(lit.span)
 480                                 .expect("must get snippet from literal"),
 481                             t.name_str(),
 482                             t.name_str(),
 483                         ))
 484                         .emit();
 485                 });
 486             }
 487         }
 488         _ => {}
 489     }
 490 }
 491
 492 impl<'tcx> LateLintPass<'tcx> for TypeLimits {
 493     fn check_expr(&mut self, cx: &LateContext<'tcx>, e: &'tcx hir::Expr<'tcx>) {
 494         match e.kind {
 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);
 499                 }
 500             }
 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()
 505                     });
 506                 }
 507             }
 508             hir::ExprKind::Lit(ref lit) => lint_literal(cx, self, e, lit),
 509             _ => {}
 510         };
 511
 512         fn is_valid<T: cmp::PartialOrd>(binop: hir::BinOp, v: T, min: T, max: T) -> bool {
 513             match binop.node {
 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,
 519                 _ => bug!(),
 520             }
 521         }
 522
 523         fn rev_binop(binop: hir::BinOp) -> hir::BinOp {
 524             source_map::respan(
 525                 binop.span,
 526                 match binop.node {
 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,
 531                     _ => return binop,
 532                 },
 533             )
 534         }
 535
 536         fn check_limits(
 537             cx: &LateContext<'_>,
 538             binop: hir::BinOp,
 539             l: &hir::Expr<'_>,
 540             r: &hir::Expr<'_>,
 541         ) -> bool {
 542             let (lit, expr, swap) = match (&l.kind, &r.kind) {
 543                 (&hir::ExprKind::Lit(_), _) => (l, r, true),
 544                 (_, &hir::ExprKind::Lit(_)) => (r, l, false),
 545                 _ => return true,
 546             };
 547             // Normalize the binop so that the literal is always on the RHS in
 548             // the comparison
 549             let norm_binop = if swap { rev_binop(binop) } else { binop };
 550             match *cx.typeck_results().node_type(expr.hir_id).kind() {
 551                 ty::Int(int_ty) => {
 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 {
 555                             ast::LitKind::Int(
 556                                 v,
 557                                 ast::LitIntType::Signed(_) | ast::LitIntType::Unsuffixed,
 558                             ) => v as i128,
 559                             _ => return true,
 560                         },
 561                         _ => bug!(),
 562                     };
 563                     is_valid(norm_binop, lit_val, min, max)
 564                 }
 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,
 570                             _ => return true,
 571                         },
 572                         _ => bug!(),
 573                     };
 574                     is_valid(norm_binop, lit_val, min, max)
 575                 }
 576                 _ => true,
 577             }
 578         }
 579
 580         fn is_comparison(binop: hir::BinOp) -> bool {
 581             matches!(
 582                 binop.node,
 583                 hir::BinOpKind::Eq
 584                     | hir::BinOpKind::Lt
 585                     | hir::BinOpKind::Le
 586                     | hir::BinOpKind::Ne
 587                     | hir::BinOpKind::Ge
 588                     | hir::BinOpKind::Gt
 589             )
 590         }
 591     }
 592 }
 593
 594 declare_lint! {
 595     /// The `improper_ctypes` lint detects incorrect use of types in foreign
 596     /// modules.
 597     ///
 598     /// ### Example
 599     ///
 600     /// ```rust
 601     /// extern "C" {
 602     ///     static STATIC: String;
 603     /// }
 604     /// ```
 605     ///
 606     /// {{produces}}
 607     ///
 608     /// ### Explanation
 609     ///
 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
 615     /// to resolve it.
 616     IMPROPER_CTYPES,
 617     Warn,
 618     "proper use of libc types in foreign modules"
 619 }
 620
 621 declare_lint_pass!(ImproperCTypesDeclarations => [IMPROPER_CTYPES]);
 622
 623 declare_lint! {
 624     /// The `improper_ctypes_definitions` lint detects incorrect use of
 625     /// [`extern` function] definitions.
 626     ///
 627     /// [`extern` function]: https://doc.rust-lang.org/reference/items/functions.html#extern-function-qualifier
 628     ///
 629     /// ### Example
 630     ///
 631     /// ```rust
 632     /// # #![allow(unused)]
 633     /// pub extern "C" fn str_type(p: &str) { }
 634     /// ```
 635     ///
 636     /// {{produces}}
 637     ///
 638     /// ### Explanation
 639     ///
 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,
 646     Warn,
 647     "proper use of libc types in foreign item definitions"
 648 }
 649
 650 declare_lint_pass!(ImproperCTypesDefinitions => [IMPROPER_CTYPES_DEFINITIONS]);
 651
 652 #[derive(Clone, Copy)]
 653 crate enum CItemKind {
 654     Declaration,
 655     Definition,
 656 }
 657
 658 struct ImproperCTypesVisitor<'a, 'tcx> {
 659     cx: &'a LateContext<'tcx>,
 660     mode: CItemKind,
 661 }
 662
 663 enum FfiResult<'tcx> {
 664     FfiSafe,
 665     FfiPhantom(Ty<'tcx>),
 666     FfiUnsafe { ty: Ty<'tcx>, reason: String, help: Option<String> },
 667 }
 668
 669 crate fn nonnull_optimization_guaranteed<'tcx>(tcx: TyCtxt<'tcx>, def: &ty::AdtDef) -> bool {
 670     tcx.get_attrs(def.did)
 671         .iter()
 672         .any(|a| tcx.sess.check_name(a, sym::rustc_nonnull_optimization_guaranteed))
 673 }
 674
 675 /// `repr(transparent)` structs can have a single non-ZST field, this function returns that
 676 /// field.
 677 pub fn transparent_newtype_field<'a, 'tcx>(
 678     tcx: TyCtxt<'tcx>,
 679     variant: &'a ty::VariantDef,
 680 ) -> Option<&'a ty::FieldDef> {
 681     let param_env = tcx.param_env(variant.def_id);
 682     for field in &variant.fields {
 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());
 685
 686         if !is_zst {
 687             return Some(field);
 688         }
 689     }
 690
 691     None
 692 }
 693
 694 /// Is type known to be non-null?
 695 fn ty_is_known_nonnull<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>, mode: CItemKind) -> bool {
 696     let tcx = cx.tcx;
 697     match ty.kind() {
 698         ty::FnPtr(_) => true,
 699         ty::Ref(..) => true,
 700         ty::Adt(def, _) if def.is_box() && matches!(mode, CItemKind::Definition) => true,
 701         ty::Adt(def, substs) if def.repr.transparent() && !def.is_union() => {
 702             let marked_non_null = nonnull_optimization_guaranteed(tcx, &def);
 703
 704             if marked_non_null {
 705                 return true;
 706             }
 707
 708             // Types with a `#[repr(no_niche)]` attribute have their niche hidden.
 709             // The attribute is used by the UnsafeCell for example (the only use so far).
 710             if def.repr.hide_niche() {
 711                 return false;
 712             }
 713
 714             for variant in &def.variants {
 715                 if let Some(field) = transparent_newtype_field(cx.tcx, variant) {
 716                     if ty_is_known_nonnull(cx, field.ty(tcx, substs), mode) {
 717                         return true;
 718                     }
 719                 }
 720             }
 721
 722             false
 723         }
 724         _ => false,
 725     }
 726 }
 727
 728 /// Given a non-null scalar (or transparent) type `ty`, return the nullable version of that type.
 729 /// If the type passed in was not scalar, returns None.
 730 fn get_nullable_type<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> Option<Ty<'tcx>> {
 731     let tcx = cx.tcx;
 732     Some(match *ty.kind() {
 733         ty::Adt(field_def, field_substs) => {
 734             let inner_field_ty = {
 735                 let first_non_zst_ty =
 736                     field_def.variants.iter().filter_map(|v| transparent_newtype_field(cx.tcx, v));
 737                 debug_assert_eq!(
 738                     first_non_zst_ty.clone().count(),
 739                     1,
 740                     "Wrong number of fields for transparent type"
 741                 );
 742                 first_non_zst_ty
 743                     .last()
 744                     .expect("No non-zst fields in transparent type.")
 745                     .ty(tcx, field_substs)
 746             };
 747             return get_nullable_type(cx, inner_field_ty);
 748         }
 749         ty::Int(ty) => tcx.mk_mach_int(ty),
 750         ty::Uint(ty) => tcx.mk_mach_uint(ty),
 751         ty::RawPtr(ty_mut) => tcx.mk_ptr(ty_mut),
 752         // As these types are always non-null, the nullable equivalent of
 753         // Option<T> of these types are their raw pointer counterparts.
 754         ty::Ref(_region, ty, mutbl) => tcx.mk_ptr(ty::TypeAndMut { ty, mutbl }),
 755         ty::FnPtr(..) => {
 756             // There is no nullable equivalent for Rust's function pointers -- you
 757             // must use an Option<fn(..) -> _> to represent it.
 758             ty
 759         }
 760
 761         // We should only ever reach this case if ty_is_known_nonnull is extended
 762         // to other types.
 763         ref unhandled => {
 764             debug!(
 765                 "get_nullable_type: Unhandled scalar kind: {:?} while checking {:?}",
 766                 unhandled, ty
 767             );
 768             return None;
 769         }
 770     })
 771 }
 772
 773 /// Check if this enum can be safely exported based on the "nullable pointer optimization". If it
 774 /// can, return the type that `ty` can be safely converted to, otherwise return `None`.
 775 /// Currently restricted to function pointers, boxes, references, `core::num::NonZero*`,
 776 /// `core::ptr::NonNull`, and `#[repr(transparent)]` newtypes.
 777 /// FIXME: This duplicates code in codegen.
 778 crate fn repr_nullable_ptr<'tcx>(
 779     cx: &LateContext<'tcx>,
 780     ty: Ty<'tcx>,
 781     ckind: CItemKind,
 782 ) -> Option<Ty<'tcx>> {
 783     debug!("is_repr_nullable_ptr(cx, ty = {:?})", ty);
 784     if let ty::Adt(ty_def, substs) = ty.kind() {
 785         if ty_def.variants.len() != 2 {
 786             return None;
 787         }
 788
 789         let get_variant_fields = |index| &ty_def.variants[VariantIdx::new(index)].fields;
 790         let variant_fields = [get_variant_fields(0), get_variant_fields(1)];
 791         let fields = if variant_fields[0].is_empty() {
 792             &variant_fields[1]
 793         } else if variant_fields[1].is_empty() {
 794             &variant_fields[0]
 795         } else {
 796             return None;
 797         };
 798
 799         if fields.len() != 1 {
 800             return None;
 801         }
 802
 803         let field_ty = fields[0].ty(cx.tcx, substs);
 804         if !ty_is_known_nonnull(cx, field_ty, ckind) {
 805             return None;
 806         }
 807
 808         // At this point, the field's type is known to be nonnull and the parent enum is Option-like.
 809         // If the computed size for the field and the enum are different, the nonnull optimization isn't
 810         // being applied (and we've got a problem somewhere).
 811         let compute_size_skeleton = |t| SizeSkeleton::compute(t, cx.tcx, cx.param_env).unwrap();
 812         if !compute_size_skeleton(ty).same_size(compute_size_skeleton(field_ty)) {
 813             bug!("improper_ctypes: Option nonnull optimization not applied?");
 814         }
 815
 816         // Return the nullable type this Option-like enum can be safely represented with.
 817         let field_ty_abi = &cx.layout_of(field_ty).unwrap().abi;
 818         if let Abi::Scalar(field_ty_scalar) = field_ty_abi {
 819             match (field_ty_scalar.valid_range.start(), field_ty_scalar.valid_range.end()) {
 820                 (0, _) => unreachable!("Non-null optimisation extended to a non-zero value."),
 821                 (1, _) => {
 822                     return Some(get_nullable_type(cx, field_ty).unwrap());
 823                 }
 824                 (start, end) => unreachable!("Unhandled start and end range: ({}, {})", start, end),
 825             };
 826         }
 827     }
 828     None
 829 }
 830
 831 impl<'a, 'tcx> ImproperCTypesVisitor<'a, 'tcx> {
 832     /// Check if the type is array and emit an unsafe type lint.
 833     fn check_for_array_ty(&mut self, sp: Span, ty: Ty<'tcx>) -> bool {
 834         if let ty::Array(..) = ty.kind() {
 835             self.emit_ffi_unsafe_type_lint(
 836                 ty,
 837                 sp,
 838                 "passing raw arrays by value is not FFI-safe",
 839                 Some("consider passing a pointer to the array"),
 840             );
 841             true
 842         } else {
 843             false
 844         }
 845     }
 846
 847     /// Checks if the given field's type is "ffi-safe".
 848     fn check_field_type_for_ffi(
 849         &self,
 850         cache: &mut FxHashSet<Ty<'tcx>>,
 851         field: &ty::FieldDef,
 852         substs: SubstsRef<'tcx>,
 853     ) -> FfiResult<'tcx> {
 854         let field_ty = field.ty(self.cx.tcx, substs);
 855         if field_ty.has_opaque_types() {
 856             self.check_type_for_ffi(cache, field_ty)
 857         } else {
 858             let field_ty = self.cx.tcx.normalize_erasing_regions(self.cx.param_env, field_ty);
 859             self.check_type_for_ffi(cache, field_ty)
 860         }
 861     }
 862
 863     /// Checks if the given `VariantDef`'s field types are "ffi-safe".
 864     fn check_variant_for_ffi(
 865         &self,
 866         cache: &mut FxHashSet<Ty<'tcx>>,
 867         ty: Ty<'tcx>,
 868         def: &ty::AdtDef,
 869         variant: &ty::VariantDef,
 870         substs: SubstsRef<'tcx>,
 871     ) -> FfiResult<'tcx> {
 872         use FfiResult::*;
 873
 874         if def.repr.transparent() {
 875             // Can assume that only one field is not a ZST, so only check
 876             // that field's type for FFI-safety.
 877             if let Some(field) = transparent_newtype_field(self.cx.tcx, variant) {
 878                 self.check_field_type_for_ffi(cache, field, substs)
 879             } else {
 880                 bug!("malformed transparent type");
 881             }
 882         } else {
 883             // We can't completely trust repr(C) markings; make sure the fields are
 884             // actually safe.
 885             let mut all_phantom = !variant.fields.is_empty();
 886             for field in &variant.fields {
 887                 match self.check_field_type_for_ffi(cache, &field, substs) {
 888                     FfiSafe => {
 889                         all_phantom = false;
 890                     }
 891                     FfiPhantom(..) if def.is_enum() => {
 892                         return FfiUnsafe {
 893                             ty,
 894                             reason: "this enum contains a PhantomData field".into(),
 895                             help: None,
 896                         };
 897                     }
 898                     FfiPhantom(..) => {}
 899                     r => return r,
 900                 }
 901             }
 902
 903             if all_phantom { FfiPhantom(ty) } else { FfiSafe }
 904         }
 905     }
 906
 907     /// Checks if the given type is "ffi-safe" (has a stable, well-defined
 908     /// representation which can be exported to C code).
 909     fn check_type_for_ffi(&self, cache: &mut FxHashSet<Ty<'tcx>>, ty: Ty<'tcx>) -> FfiResult<'tcx> {
 910         use FfiResult::*;
 911
 912         let tcx = self.cx.tcx;
 913
 914         // Protect against infinite recursion, for example
 915         // `struct S(*mut S);`.
 916         // FIXME: A recursion limit is necessary as well, for irregular
 917         // recursive types.
 918         if !cache.insert(ty) {
 919             return FfiSafe;
 920         }
 921
 922         match *ty.kind() {
 923             ty::Adt(def, _) if def.is_box() && matches!(self.mode, CItemKind::Definition) => {
 924                 FfiSafe
 925             }
 926
 927             ty::Adt(def, substs) => {
 928                 if def.is_phantom_data() {
 929                     return FfiPhantom(ty);
 930                 }
 931                 match def.adt_kind() {
 932                     AdtKind::Struct | AdtKind::Union => {
 933                         let kind = if def.is_struct() { "struct" } else { "union" };
 934
 935                         if !def.repr.c() && !def.repr.transparent() {
 936                             return FfiUnsafe {
 937                                 ty,
 938                                 reason: format!("this {} has unspecified layout", kind),
 939                                 help: Some(format!(
 940                                     "consider adding a `#[repr(C)]` or \
 941                                              `#[repr(transparent)]` attribute to this {}",
 942                                     kind
 943                                 )),
 944                             };
 945                         }
 946
 947                         let is_non_exhaustive =
 948                             def.non_enum_variant().is_field_list_non_exhaustive();
 949                         if is_non_exhaustive && !def.did.is_local() {
 950                             return FfiUnsafe {
 951                                 ty,
 952                                 reason: format!("this {} is non-exhaustive", kind),
 953                                 help: None,
 954                             };
 955                         }
 956
 957                         if def.non_enum_variant().fields.is_empty() {
 958                             return FfiUnsafe {
 959                                 ty,
 960                                 reason: format!("this {} has no fields", kind),
 961                                 help: Some(format!("consider adding a member to this {}", kind)),
 962                             };
 963                         }
 964
 965                         self.check_variant_for_ffi(cache, ty, def, def.non_enum_variant(), substs)
 966                     }
 967                     AdtKind::Enum => {
 968                         if def.variants.is_empty() {
 969                             // Empty enums are okay... although sort of useless.
 970                             return FfiSafe;
 971                         }
 972
 973                         // Check for a repr() attribute to specify the size of the
 974                         // discriminant.
 975                         if !def.repr.c() && !def.repr.transparent() && def.repr.int.is_none() {
 976                             // Special-case types like `Option<extern fn()>`.
 977                             if repr_nullable_ptr(self.cx, ty, self.mode).is_none() {
 978                                 return FfiUnsafe {
 979                                     ty,
 980                                     reason: "enum has no representation hint".into(),
 981                                     help: Some(
 982                                         "consider adding a `#[repr(C)]`, \
 983                                                 `#[repr(transparent)]`, or integer `#[repr(...)]` \
 984                                                 attribute to this enum"
 985                                             .into(),
 986                                     ),
 987                                 };
 988                             }
 989                         }
 990
 991                         if def.is_variant_list_non_exhaustive() && !def.did.is_local() {
 992                             return FfiUnsafe {
 993                                 ty,
 994                                 reason: "this enum is non-exhaustive".into(),
 995                                 help: None,
 996                             };
 997                         }
 998
 999                         // Check the contained variants.
1000                         for variant in &def.variants {
1001                             let is_non_exhaustive = variant.is_field_list_non_exhaustive();
1002                             if is_non_exhaustive && !variant.def_id.is_local() {
1003                                 return FfiUnsafe {
1004                                     ty,
1005                                     reason: "this enum has non-exhaustive variants".into(),
1006                                     help: None,
1007                                 };
1008                             }
1009
1010                             match self.check_variant_for_ffi(cache, ty, def, variant, substs) {
1011                                 FfiSafe => (),
1012                                 r => return r,
1013                             }
1014                         }
1015
1016                         FfiSafe
1017                     }
1018                 }
1019             }
1020
1021             ty::Char => FfiUnsafe {
1022                 ty,
1023                 reason: "the `char` type has no C equivalent".into(),
1024                 help: Some("consider using `u32` or `libc::wchar_t` instead".into()),
1025             },
1026
1027             ty::Int(ty::IntTy::I128) | ty::Uint(ty::UintTy::U128) => FfiUnsafe {
1028                 ty,
1029                 reason: "128-bit integers don't currently have a known stable ABI".into(),
1030                 help: None,
1031             },
1032
1033             // Primitive types with a stable representation.
1034             ty::Bool | ty::Int(..) | ty::Uint(..) | ty::Float(..) | ty::Never => FfiSafe,
1035
1036             ty::Slice(_) => FfiUnsafe {
1037                 ty,
1038                 reason: "slices have no C equivalent".into(),
1039                 help: Some("consider using a raw pointer instead".into()),
1040             },
1041
1042             ty::Dynamic(..) => {
1043                 FfiUnsafe { ty, reason: "trait objects have no C equivalent".into(), help: None }
1044             }
1045
1046             ty::Str => FfiUnsafe {
1047                 ty,
1048                 reason: "string slices have no C equivalent".into(),
1049                 help: Some("consider using `*const u8` and a length instead".into()),
1050             },
1051
1052             ty::Tuple(..) => FfiUnsafe {
1053                 ty,
1054                 reason: "tuples have unspecified layout".into(),
1055                 help: Some("consider using a struct instead".into()),
1056             },
1057
1058             ty::RawPtr(ty::TypeAndMut { ty, .. }) | ty::Ref(_, ty, _)
1059                 if {
1060                     matches!(self.mode, CItemKind::Definition)
1061                         && ty.is_sized(self.cx.tcx.at(DUMMY_SP), self.cx.param_env)
1062                 } =>
1063             {
1064                 FfiSafe
1065             }
1066
1067             ty::RawPtr(ty::TypeAndMut { ty, .. }) | ty::Ref(_, ty, _) => {
1068                 self.check_type_for_ffi(cache, ty)
1069             }
1070
1071             ty::Array(inner_ty, _) => self.check_type_for_ffi(cache, inner_ty),
1072
1073             ty::FnPtr(sig) => {
1074                 if self.is_internal_abi(sig.abi()) {
1075                     return FfiUnsafe {
1076                         ty,
1077                         reason: "this function pointer has Rust-specific calling convention".into(),
1078                         help: Some(
1079                             "consider using an `extern fn(...) -> ...` \
1080                                     function pointer instead"
1081                                 .into(),
1082                         ),
1083                     };
1084                 }
1085
1086                 let sig = tcx.erase_late_bound_regions(sig);
1087                 if !sig.output().is_unit() {
1088                     let r = self.check_type_for_ffi(cache, sig.output());
1089                     match r {
1090                         FfiSafe => {}
1091                         _ => {
1092                             return r;
1093                         }
1094                     }
1095                 }
1096                 for arg in sig.inputs() {
1097                     let r = self.check_type_for_ffi(cache, arg);
1098                     match r {
1099                         FfiSafe => {}
1100                         _ => {
1101                             return r;
1102                         }
1103                     }
1104                 }
1105                 FfiSafe
1106             }
1107
1108             ty::Foreign(..) => FfiSafe,
1109
1110             // While opaque types are checked for earlier, if a projection in a struct field
1111             // normalizes to an opaque type, then it will reach this branch.
1112             ty::Opaque(..) => {
1113                 FfiUnsafe { ty, reason: "opaque types have no C equivalent".into(), help: None }
1114             }
1115
1116             // `extern "C" fn` functions can have type parameters, which may or may not be FFI-safe,
1117             //  so they are currently ignored for the purposes of this lint.
1118             ty::Param(..) | ty::Projection(..) if matches!(self.mode, CItemKind::Definition) => {
1119                 FfiSafe
1120             }
1121
1122             ty::Param(..)
1123             | ty::Projection(..)
1124             | ty::Infer(..)
1125             | ty::Bound(..)
1126             | ty::Error(_)
1127             | ty::Closure(..)
1128             | ty::Generator(..)
1129             | ty::GeneratorWitness(..)
1130             | ty::Placeholder(..)
1131             | ty::FnDef(..) => bug!("unexpected type in foreign function: {:?}", ty),
1132         }
1133     }
1134
1135     fn emit_ffi_unsafe_type_lint(
1136         &mut self,
1137         ty: Ty<'tcx>,
1138         sp: Span,
1139         note: &str,
1140         help: Option<&str>,
1141     ) {
1142         let lint = match self.mode {
1143             CItemKind::Declaration => IMPROPER_CTYPES,
1144             CItemKind::Definition => IMPROPER_CTYPES_DEFINITIONS,
1145         };
1146
1147         self.cx.struct_span_lint(lint, sp, |lint| {
1148             let item_description = match self.mode {
1149                 CItemKind::Declaration => "block",
1150                 CItemKind::Definition => "fn",
1151             };
1152             let mut diag = lint.build(&format!(
1153                 "`extern` {} uses type `{}`, which is not FFI-safe",
1154                 item_description, ty
1155             ));
1156             diag.span_label(sp, "not FFI-safe");
1157             if let Some(help) = help {
1158                 diag.help(help);
1159             }
1160             diag.note(note);
1161             if let ty::Adt(def, _) = ty.kind() {
1162                 if let Some(sp) = self.cx.tcx.hir().span_if_local(def.did) {
1163                     diag.span_note(sp, "the type is defined here");
1164                 }
1165             }
1166             diag.emit();
1167         });
1168     }
1169
1170     fn check_for_opaque_ty(&mut self, sp: Span, ty: Ty<'tcx>) -> bool {
1171         struct ProhibitOpaqueTypes<'a, 'tcx> {
1172             cx: &'a LateContext<'tcx>,
1173         }
1174
1175         impl<'a, 'tcx> ty::fold::TypeVisitor<'tcx> for ProhibitOpaqueTypes<'a, 'tcx> {
1176             type BreakTy = Ty<'tcx>;
1177
1178             fn visit_ty(&mut self, ty: Ty<'tcx>) -> ControlFlow<Self::BreakTy> {
1179                 match ty.kind() {
1180                     ty::Opaque(..) => ControlFlow::Break(ty),
1181                     // Consider opaque types within projections FFI-safe if they do not normalize
1182                     // to more opaque types.
1183                     ty::Projection(..) => {
1184                         let ty = self.cx.tcx.normalize_erasing_regions(self.cx.param_env, ty);
1185
1186                         // If `ty` is a opaque type directly then `super_visit_with` won't invoke
1187                         // this function again.
1188                         if ty.has_opaque_types() {
1189                             self.visit_ty(ty)
1190                         } else {
1191                             ControlFlow::CONTINUE
1192                         }
1193                     }
1194                     _ => ty.super_visit_with(self),
1195                 }
1196             }
1197         }
1198
1199         if let Some(ty) = ty.visit_with(&mut ProhibitOpaqueTypes { cx: self.cx }).break_value() {
1200             self.emit_ffi_unsafe_type_lint(ty, sp, "opaque types have no C equivalent", None);
1201             true
1202         } else {
1203             false
1204         }
1205     }
1206
1207     fn check_type_for_ffi_and_report_errors(
1208         &mut self,
1209         sp: Span,
1210         ty: Ty<'tcx>,
1211         is_static: bool,
1212         is_return_type: bool,
1213     ) {
1214         // We have to check for opaque types before `normalize_erasing_regions`,
1215         // which will replace opaque types with their underlying concrete type.
1216         if self.check_for_opaque_ty(sp, ty) {
1217             // We've already emitted an error due to an opaque type.
1218             return;
1219         }
1220
1221         // it is only OK to use this function because extern fns cannot have
1222         // any generic types right now:
1223         let ty = self.cx.tcx.normalize_erasing_regions(self.cx.param_env, ty);
1224
1225         // C doesn't really support passing arrays by value - the only way to pass an array by value
1226         // is through a struct. So, first test that the top level isn't an array, and then
1227         // recursively check the types inside.
1228         if !is_static && self.check_for_array_ty(sp, ty) {
1229             return;
1230         }
1231
1232         // Don't report FFI errors for unit return types. This check exists here, and not in
1233         // `check_foreign_fn` (where it would make more sense) so that normalization has definitely
1234         // happened.
1235         if is_return_type && ty.is_unit() {
1236             return;
1237         }
1238
1239         match self.check_type_for_ffi(&mut FxHashSet::default(), ty) {
1240             FfiResult::FfiSafe => {}
1241             FfiResult::FfiPhantom(ty) => {
1242                 self.emit_ffi_unsafe_type_lint(ty, sp, "composed only of `PhantomData`", None);
1243             }
1244             // If `ty` is a `repr(transparent)` newtype, and the non-zero-sized type is a generic
1245             // argument, which after substitution, is `()`, then this branch can be hit.
1246             FfiResult::FfiUnsafe { ty, .. } if is_return_type && ty.is_unit() => {}
1247             FfiResult::FfiUnsafe { ty, reason, help } => {
1248                 self.emit_ffi_unsafe_type_lint(ty, sp, &reason, help.as_deref());
1249             }
1250         }
1251     }
1252
1253     fn check_foreign_fn(&mut self, id: hir::HirId, decl: &hir::FnDecl<'_>) {
1254         let def_id = self.cx.tcx.hir().local_def_id(id);
1255         let sig = self.cx.tcx.fn_sig(def_id);
1256         let sig = self.cx.tcx.erase_late_bound_regions(sig);
1257
1258         for (input_ty, input_hir) in sig.inputs().iter().zip(decl.inputs) {
1259             self.check_type_for_ffi_and_report_errors(input_hir.span, input_ty, false, false);
1260         }
1261
1262         if let hir::FnRetTy::Return(ref ret_hir) = decl.output {
1263             let ret_ty = sig.output();
1264             self.check_type_for_ffi_and_report_errors(ret_hir.span, ret_ty, false, true);
1265         }
1266     }
1267
1268     fn check_foreign_static(&mut self, id: hir::HirId, span: Span) {
1269         let def_id = self.cx.tcx.hir().local_def_id(id);
1270         let ty = self.cx.tcx.type_of(def_id);
1271         self.check_type_for_ffi_and_report_errors(span, ty, true, false);
1272     }
1273
1274     fn is_internal_abi(&self, abi: SpecAbi) -> bool {
1275         matches!(
1276             abi,
1277             SpecAbi::Rust | SpecAbi::RustCall | SpecAbi::RustIntrinsic | SpecAbi::PlatformIntrinsic
1278         )
1279     }
1280 }
1281
1282 impl<'tcx> LateLintPass<'tcx> for ImproperCTypesDeclarations {
1283     fn check_foreign_item(&mut self, cx: &LateContext<'_>, it: &hir::ForeignItem<'_>) {
1284         let mut vis = ImproperCTypesVisitor { cx, mode: CItemKind::Declaration };
1285         let abi = cx.tcx.hir().get_foreign_abi(it.hir_id());
1286
1287         if !vis.is_internal_abi(abi) {
1288             match it.kind {
1289                 hir::ForeignItemKind::Fn(ref decl, _, _) => {
1290                     vis.check_foreign_fn(it.hir_id(), decl);
1291                 }
1292                 hir::ForeignItemKind::Static(ref ty, _) => {
1293                     vis.check_foreign_static(it.hir_id(), ty.span);
1294                 }
1295                 hir::ForeignItemKind::Type => (),
1296             }
1297         }
1298     }
1299 }
1300
1301 impl<'tcx> LateLintPass<'tcx> for ImproperCTypesDefinitions {
1302     fn check_fn(
1303         &mut self,
1304         cx: &LateContext<'tcx>,
1305         kind: hir::intravisit::FnKind<'tcx>,
1306         decl: &'tcx hir::FnDecl<'_>,
1307         _: &'tcx hir::Body<'_>,
1308         _: Span,
1309         hir_id: hir::HirId,
1310     ) {
1311         use hir::intravisit::FnKind;
1312
1313         let abi = match kind {
1314             FnKind::ItemFn(_, _, header, ..) => header.abi,
1315             FnKind::Method(_, sig, ..) => sig.header.abi,
1316             _ => return,
1317         };
1318
1319         let mut vis = ImproperCTypesVisitor { cx, mode: CItemKind::Definition };
1320         if !vis.is_internal_abi(abi) {
1321             vis.check_foreign_fn(hir_id, decl);
1322         }
1323     }
1324 }
1325
1326 declare_lint_pass!(VariantSizeDifferences => [VARIANT_SIZE_DIFFERENCES]);
1327
1328 impl<'tcx> LateLintPass<'tcx> for VariantSizeDifferences {
1329     fn check_item(&mut self, cx: &LateContext<'_>, it: &hir::Item<'_>) {
1330         if let hir::ItemKind::Enum(ref enum_definition, _) = it.kind {
1331             let t = cx.tcx.type_of(it.def_id);
1332             let ty = cx.tcx.erase_regions(t);
1333             let layout = match cx.layout_of(ty) {
1334                 Ok(layout) => layout,
1335                 Err(
1336                     ty::layout::LayoutError::Unknown(_) | ty::layout::LayoutError::SizeOverflow(_),
1337                 ) => return,
1338             };
1339             let (variants, tag) = match layout.variants {
1340                 Variants::Multiple {
1341                     tag_encoding: TagEncoding::Direct,
1342                     ref tag,
1343                     ref variants,
1344                     ..
1345                 } => (variants, tag),
1346                 _ => return,
1347             };
1348
1349             let tag_size = tag.value.size(&cx.tcx).bytes();
1350
1351             debug!(
1352                 "enum `{}` is {} bytes large with layout:\n{:#?}",
1353                 t,
1354                 layout.size.bytes(),
1355                 layout
1356             );
1357
1358             let (largest, slargest, largest_index) = enum_definition
1359                 .variants
1360                 .iter()
1361                 .zip(variants)
1362                 .map(|(variant, variant_layout)| {
1363                     // Subtract the size of the enum tag.
1364                     let bytes = variant_layout.size.bytes().saturating_sub(tag_size);
1365
1366                     debug!("- variant `{}` is {} bytes large", variant.ident, bytes);
1367                     bytes
1368                 })
1369                 .enumerate()
1370                 .fold((0, 0, 0), |(l, s, li), (idx, size)| {
1371                     if size > l {
1372                         (size, l, idx)
1373                     } else if size > s {
1374                         (l, size, li)
1375                     } else {
1376                         (l, s, li)
1377                     }
1378                 });
1379
1380             // We only warn if the largest variant is at least thrice as large as
1381             // the second-largest.
1382             if largest > slargest * 3 && slargest > 0 {
1383                 cx.struct_span_lint(
1384                     VARIANT_SIZE_DIFFERENCES,
1385                     enum_definition.variants[largest_index].span,
1386                     |lint| {
1387                         lint.build(&format!(
1388                             "enum variant is more than three times \
1389                                           larger ({} bytes) than the next largest",
1390                             largest
1391                         ))
1392                         .emit()
1393                     },
1394                 );
1395             }
1396         }
1397     }
1398 }