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