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