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