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