src/librustc_lint/builtin.rs

   1 //! Lints in the Rust compiler.
   2 //!
   3 //! This contains lints which can feasibly be implemented as their own
   4 //! AST visitor. Also see `rustc_session::lint::builtin`, which contains the
   5 //! definitions of lints that are emitted directly inside the main compiler.
   6 //!
   7 //! To add a new lint to rustc, declare it here using `declare_lint!()`.
   8 //! Then add code to emit the new lint in the appropriate circumstances.
   9 //! You can do that in an existing `LintPass` if it makes sense, or in a
  10 //! new `LintPass`, or using `Session::add_lint` elsewhere in the
  11 //! compiler. Only do the latter if the check can't be written cleanly as a
  12 //! `LintPass` (also, note that such lints will need to be defined in
  13 //! `rustc_session::lint::builtin`, not here).
  14 //!
  15 //! If you define a new `EarlyLintPass`, you will also need to add it to the
  16 //! `add_early_builtin!` or `add_early_builtin_with_new!` invocation in
  17 //! `lib.rs`. Use the former for unit-like structs and the latter for structs
  18 //! with a `pub fn new()`.
  19 //!
  20 //! If you define a new `LateLintPass`, you will also need to add it to the
  21 //! `late_lint_methods!` invocation in `lib.rs`.
  22
  23 use crate::{EarlyContext, EarlyLintPass, LateContext, LateLintPass, LintContext};
  24 use rustc_ast::ast::{self, Expr};
  25 use rustc_ast::attr::{self, HasAttrs};
  26 use rustc_ast::tokenstream::{TokenStream, TokenTree};
  27 use rustc_ast::visit::{FnCtxt, FnKind};
  28 use rustc_ast_pretty::pprust::{self, expr_to_string};
  29 use rustc_data_structures::fx::FxHashSet;
  30 use rustc_errors::{Applicability, DiagnosticBuilder};
  31 use rustc_feature::{deprecated_attributes, AttributeGate, AttributeTemplate, AttributeType};
  32 use rustc_feature::{GateIssue, Stability};
  33 use rustc_hir as hir;
  34 use rustc_hir::def::{DefKind, Res};
  35 use rustc_hir::def_id::DefId;
  36 use rustc_hir::{GenericParamKind, PatKind};
  37 use rustc_hir::{HirIdSet, Node};
  38 use rustc_middle::lint::LintDiagnosticBuilder;
  39 use rustc_middle::ty::subst::GenericArgKind;
  40 use rustc_middle::ty::{self, Ty, TyCtxt};
  41 use rustc_session::lint::FutureIncompatibleInfo;
  42 use rustc_span::edition::Edition;
  43 use rustc_span::source_map::Spanned;
  44 use rustc_span::symbol::{kw, sym, Ident, Symbol};
  45 use rustc_span::{BytePos, Span};
  46 use rustc_target::abi::VariantIdx;
  47 use rustc_trait_selection::traits::misc::can_type_implement_copy;
  48
  49 use crate::nonstandard_style::{method_context, MethodLateContext};
  50
  51 use log::debug;
  52 use std::fmt::Write;
  53
  54 // hardwired lints from librustc_middle
  55 pub use rustc_session::lint::builtin::*;
  56
  57 declare_lint! {
  58     WHILE_TRUE,
  59     Warn,
  60     "suggest using `loop { }` instead of `while true { }`"
  61 }
  62
  63 declare_lint_pass!(WhileTrue => [WHILE_TRUE]);
  64
  65 /// Traverse through any amount of parenthesis and return the first non-parens expression.
  66 fn pierce_parens(mut expr: &ast::Expr) -> &ast::Expr {
  67     while let ast::ExprKind::Paren(sub) = &expr.kind {
  68         expr = sub;
  69     }
  70     expr
  71 }
  72
  73 impl EarlyLintPass for WhileTrue {
  74     fn check_expr(&mut self, cx: &EarlyContext<'_>, e: &ast::Expr) {
  75         if let ast::ExprKind::While(cond, ..) = &e.kind {
  76             if let ast::ExprKind::Lit(ref lit) = pierce_parens(cond).kind {
  77                 if let ast::LitKind::Bool(true) = lit.kind {
  78                     if !lit.span.from_expansion() {
  79                         let msg = "denote infinite loops with `loop { ... }`";
  80                         let condition_span = cx.sess.source_map().guess_head_span(e.span);
  81                         cx.struct_span_lint(WHILE_TRUE, condition_span, |lint| {
  82                             lint.build(msg)
  83                                 .span_suggestion_short(
  84                                     condition_span,
  85                                     "use `loop`",
  86                                     "loop".to_owned(),
  87                                     Applicability::MachineApplicable,
  88                                 )
  89                                 .emit();
  90                         })
  91                     }
  92                 }
  93             }
  94         }
  95     }
  96 }
  97
  98 declare_lint! {
  99     BOX_POINTERS,
 100     Allow,
 101     "use of owned (Box type) heap memory"
 102 }
 103
 104 declare_lint_pass!(BoxPointers => [BOX_POINTERS]);
 105
 106 impl BoxPointers {
 107     fn check_heap_type(&self, cx: &LateContext<'_, '_>, span: Span, ty: Ty<'_>) {
 108         for leaf in ty.walk() {
 109             if let GenericArgKind::Type(leaf_ty) = leaf.unpack() {
 110                 if leaf_ty.is_box() {
 111                     cx.struct_span_lint(BOX_POINTERS, span, |lint| {
 112                         lint.build(&format!("type uses owned (Box type) pointers: {}", ty)).emit()
 113                     });
 114                 }
 115             }
 116         }
 117     }
 118 }
 119
 120 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for BoxPointers {
 121     fn check_item(&mut self, cx: &LateContext<'_, '_>, it: &hir::Item<'_>) {
 122         match it.kind {
 123             hir::ItemKind::Fn(..)
 124             | hir::ItemKind::TyAlias(..)
 125             | hir::ItemKind::Enum(..)
 126             | hir::ItemKind::Struct(..)
 127             | hir::ItemKind::Union(..) => {
 128                 let def_id = cx.tcx.hir().local_def_id(it.hir_id);
 129                 self.check_heap_type(cx, it.span, cx.tcx.type_of(def_id))
 130             }
 131             _ => (),
 132         }
 133
 134         // If it's a struct, we also have to check the fields' types
 135         match it.kind {
 136             hir::ItemKind::Struct(ref struct_def, _) | hir::ItemKind::Union(ref struct_def, _) => {
 137                 for struct_field in struct_def.fields() {
 138                     let def_id = cx.tcx.hir().local_def_id(struct_field.hir_id);
 139                     self.check_heap_type(cx, struct_field.span, cx.tcx.type_of(def_id));
 140                 }
 141             }
 142             _ => (),
 143         }
 144     }
 145
 146     fn check_expr(&mut self, cx: &LateContext<'_, '_>, e: &hir::Expr<'_>) {
 147         let ty = cx.tables.node_type(e.hir_id);
 148         self.check_heap_type(cx, e.span, ty);
 149     }
 150 }
 151
 152 declare_lint! {
 153     NON_SHORTHAND_FIELD_PATTERNS,
 154     Warn,
 155     "using `Struct { x: x }` instead of `Struct { x }` in a pattern"
 156 }
 157
 158 declare_lint_pass!(NonShorthandFieldPatterns => [NON_SHORTHAND_FIELD_PATTERNS]);
 159
 160 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for NonShorthandFieldPatterns {
 161     fn check_pat(&mut self, cx: &LateContext<'_, '_>, pat: &hir::Pat<'_>) {
 162         if let PatKind::Struct(ref qpath, field_pats, _) = pat.kind {
 163             let variant = cx
 164                 .tables
 165                 .pat_ty(pat)
 166                 .ty_adt_def()
 167                 .expect("struct pattern type is not an ADT")
 168                 .variant_of_res(cx.tables.qpath_res(qpath, pat.hir_id));
 169             for fieldpat in field_pats {
 170                 if fieldpat.is_shorthand {
 171                     continue;
 172                 }
 173                 if fieldpat.span.from_expansion() {
 174                     // Don't lint if this is a macro expansion: macro authors
 175                     // shouldn't have to worry about this kind of style issue
 176                     // (Issue #49588)
 177                     continue;
 178                 }
 179                 if let PatKind::Binding(binding_annot, _, ident, None) = fieldpat.pat.kind {
 180                     if cx.tcx.find_field_index(ident, &variant)
 181                         == Some(cx.tcx.field_index(fieldpat.hir_id, cx.tables))
 182                     {
 183                         cx.struct_span_lint(NON_SHORTHAND_FIELD_PATTERNS, fieldpat.span, |lint| {
 184                             let mut err = lint
 185                                 .build(&format!("the `{}:` in this pattern is redundant", ident));
 186                             let binding = match binding_annot {
 187                                 hir::BindingAnnotation::Unannotated => None,
 188                                 hir::BindingAnnotation::Mutable => Some("mut"),
 189                                 hir::BindingAnnotation::Ref => Some("ref"),
 190                                 hir::BindingAnnotation::RefMut => Some("ref mut"),
 191                             };
 192                             let ident = if let Some(binding) = binding {
 193                                 format!("{} {}", binding, ident)
 194                             } else {
 195                                 ident.to_string()
 196                             };
 197                             err.span_suggestion(
 198                                 fieldpat.span,
 199                                 "use shorthand field pattern",
 200                                 ident,
 201                                 Applicability::MachineApplicable,
 202                             );
 203                             err.emit();
 204                         });
 205                     }
 206                 }
 207             }
 208         }
 209     }
 210 }
 211
 212 declare_lint! {
 213     UNSAFE_CODE,
 214     Allow,
 215     "usage of `unsafe` code"
 216 }
 217
 218 declare_lint_pass!(UnsafeCode => [UNSAFE_CODE]);
 219
 220 impl UnsafeCode {
 221     fn report_unsafe(
 222         &self,
 223         cx: &EarlyContext<'_>,
 224         span: Span,
 225         decorate: impl for<'a> FnOnce(LintDiagnosticBuilder<'a>),
 226     ) {
 227         // This comes from a macro that has `#[allow_internal_unsafe]`.
 228         if span.allows_unsafe() {
 229             return;
 230         }
 231
 232         cx.struct_span_lint(UNSAFE_CODE, span, decorate);
 233     }
 234 }
 235
 236 impl EarlyLintPass for UnsafeCode {
 237     fn check_attribute(&mut self, cx: &EarlyContext<'_>, attr: &ast::Attribute) {
 238         if attr.check_name(sym::allow_internal_unsafe) {
 239             self.report_unsafe(cx, attr.span, |lint| {
 240                 lint.build(
 241                     "`allow_internal_unsafe` allows defining \
 242                                                macros using unsafe without triggering \
 243                                                the `unsafe_code` lint at their call site",
 244                 )
 245                 .emit()
 246             });
 247         }
 248     }
 249
 250     fn check_expr(&mut self, cx: &EarlyContext<'_>, e: &ast::Expr) {
 251         if let ast::ExprKind::Block(ref blk, _) = e.kind {
 252             // Don't warn about generated blocks; that'll just pollute the output.
 253             if blk.rules == ast::BlockCheckMode::Unsafe(ast::UserProvided) {
 254                 self.report_unsafe(cx, blk.span, |lint| {
 255                     lint.build("usage of an `unsafe` block").emit()
 256                 });
 257             }
 258         }
 259     }
 260
 261     fn check_item(&mut self, cx: &EarlyContext<'_>, it: &ast::Item) {
 262         match it.kind {
 263             ast::ItemKind::Trait(_, ast::Unsafe::Yes(_), ..) => {
 264                 self.report_unsafe(cx, it.span, |lint| {
 265                     lint.build("declaration of an `unsafe` trait").emit()
 266                 })
 267             }
 268
 269             ast::ItemKind::Impl { unsafety: ast::Unsafe::Yes(_), .. } => {
 270                 self.report_unsafe(cx, it.span, |lint| {
 271                     lint.build("implementation of an `unsafe` trait").emit()
 272                 })
 273             }
 274
 275             _ => {}
 276         }
 277     }
 278
 279     fn check_fn(&mut self, cx: &EarlyContext<'_>, fk: FnKind<'_>, span: Span, _: ast::NodeId) {
 280         if let FnKind::Fn(
 281             ctxt,
 282             _,
 283             ast::FnSig { header: ast::FnHeader { unsafety: ast::Unsafe::Yes(_), .. }, .. },
 284             _,
 285             body,
 286         ) = fk
 287         {
 288             let msg = match ctxt {
 289                 FnCtxt::Foreign => return,
 290                 FnCtxt::Free => "declaration of an `unsafe` function",
 291                 FnCtxt::Assoc(_) if body.is_none() => "declaration of an `unsafe` method",
 292                 FnCtxt::Assoc(_) => "implementation of an `unsafe` method",
 293             };
 294             self.report_unsafe(cx, span, |lint| lint.build(msg).emit());
 295         }
 296     }
 297 }
 298
 299 declare_lint! {
 300     pub MISSING_DOCS,
 301     Allow,
 302     "detects missing documentation for public members",
 303     report_in_external_macro
 304 }
 305
 306 pub struct MissingDoc {
 307     /// Stack of whether `#[doc(hidden)]` is set at each level which has lint attributes.
 308     doc_hidden_stack: Vec<bool>,
 309
 310     /// Private traits or trait items that leaked through. Don't check their methods.
 311     private_traits: FxHashSet<hir::HirId>,
 312 }
 313
 314 impl_lint_pass!(MissingDoc => [MISSING_DOCS]);
 315
 316 fn has_doc(attr: &ast::Attribute) -> bool {
 317     if attr.is_doc_comment() {
 318         return true;
 319     }
 320
 321     if !attr.check_name(sym::doc) {
 322         return false;
 323     }
 324
 325     if attr.is_value_str() {
 326         return true;
 327     }
 328
 329     if let Some(list) = attr.meta_item_list() {
 330         for meta in list {
 331             if meta.check_name(sym::include) || meta.check_name(sym::hidden) {
 332                 return true;
 333             }
 334         }
 335     }
 336
 337     false
 338 }
 339
 340 impl MissingDoc {
 341     pub fn new() -> MissingDoc {
 342         MissingDoc { doc_hidden_stack: vec![false], private_traits: FxHashSet::default() }
 343     }
 344
 345     fn doc_hidden(&self) -> bool {
 346         *self.doc_hidden_stack.last().expect("empty doc_hidden_stack")
 347     }
 348
 349     fn check_missing_docs_attrs(
 350         &self,
 351         cx: &LateContext<'_, '_>,
 352         id: Option<hir::HirId>,
 353         attrs: &[ast::Attribute],
 354         sp: Span,
 355         article: &'static str,
 356         desc: &'static str,
 357     ) {
 358         // If we're building a test harness, then warning about
 359         // documentation is probably not really relevant right now.
 360         if cx.sess().opts.test {
 361             return;
 362         }
 363
 364         // `#[doc(hidden)]` disables missing_docs check.
 365         if self.doc_hidden() {
 366             return;
 367         }
 368
 369         // Only check publicly-visible items, using the result from the privacy pass.
 370         // It's an option so the crate root can also use this function (it doesn't
 371         // have a `NodeId`).
 372         if let Some(id) = id {
 373             if !cx.access_levels.is_exported(id) {
 374                 return;
 375             }
 376         }
 377
 378         let has_doc = attrs.iter().any(|a| has_doc(a));
 379         if !has_doc {
 380             cx.struct_span_lint(
 381                 MISSING_DOCS,
 382                 cx.tcx.sess.source_map().guess_head_span(sp),
 383                 |lint| {
 384                     lint.build(&format!("missing documentation for {} {}", article, desc)).emit()
 385                 },
 386             );
 387         }
 388     }
 389 }
 390
 391 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MissingDoc {
 392     fn enter_lint_attrs(&mut self, _: &LateContext<'_, '_>, attrs: &[ast::Attribute]) {
 393         let doc_hidden = self.doc_hidden()
 394             || attrs.iter().any(|attr| {
 395                 attr.check_name(sym::doc)
 396                     && match attr.meta_item_list() {
 397                         None => false,
 398                         Some(l) => attr::list_contains_name(&l, sym::hidden),
 399                     }
 400             });
 401         self.doc_hidden_stack.push(doc_hidden);
 402     }
 403
 404     fn exit_lint_attrs(&mut self, _: &LateContext<'_, '_>, _attrs: &[ast::Attribute]) {
 405         self.doc_hidden_stack.pop().expect("empty doc_hidden_stack");
 406     }
 407
 408     fn check_crate(&mut self, cx: &LateContext<'_, '_>, krate: &hir::Crate<'_>) {
 409         self.check_missing_docs_attrs(cx, None, &krate.item.attrs, krate.item.span, "the", "crate");
 410
 411         for macro_def in krate.exported_macros {
 412             let has_doc = macro_def.attrs.iter().any(|a| has_doc(a));
 413             if !has_doc {
 414                 cx.struct_span_lint(
 415                     MISSING_DOCS,
 416                     cx.tcx.sess.source_map().guess_head_span(macro_def.span),
 417                     |lint| lint.build("missing documentation for macro").emit(),
 418                 );
 419             }
 420         }
 421     }
 422
 423     fn check_item(&mut self, cx: &LateContext<'_, '_>, it: &hir::Item<'_>) {
 424         match it.kind {
 425             hir::ItemKind::Trait(.., trait_item_refs) => {
 426                 // Issue #11592: traits are always considered exported, even when private.
 427                 if let hir::VisibilityKind::Inherited = it.vis.node {
 428                     self.private_traits.insert(it.hir_id);
 429                     for trait_item_ref in trait_item_refs {
 430                         self.private_traits.insert(trait_item_ref.id.hir_id);
 431                     }
 432                     return;
 433                 }
 434             }
 435             hir::ItemKind::Impl { of_trait: Some(ref trait_ref), items, .. } => {
 436                 // If the trait is private, add the impl items to `private_traits` so they don't get
 437                 // reported for missing docs.
 438                 let real_trait = trait_ref.path.res.def_id();
 439                 if let Some(def_id) = real_trait.as_local() {
 440                     let hir_id = cx.tcx.hir().as_local_hir_id(def_id);
 441                     if let Some(Node::Item(item)) = cx.tcx.hir().find(hir_id) {
 442                         if let hir::VisibilityKind::Inherited = item.vis.node {
 443                             for impl_item_ref in items {
 444                                 self.private_traits.insert(impl_item_ref.id.hir_id);
 445                             }
 446                         }
 447                     }
 448                 }
 449                 return;
 450             }
 451
 452             hir::ItemKind::TyAlias(..)
 453             | hir::ItemKind::Fn(..)
 454             | hir::ItemKind::Mod(..)
 455             | hir::ItemKind::Enum(..)
 456             | hir::ItemKind::Struct(..)
 457             | hir::ItemKind::Union(..)
 458             | hir::ItemKind::Const(..)
 459             | hir::ItemKind::Static(..) => {}
 460
 461             _ => return,
 462         };
 463
 464         let def_id = cx.tcx.hir().local_def_id(it.hir_id);
 465         let (article, desc) = cx.tcx.article_and_description(def_id.to_def_id());
 466
 467         self.check_missing_docs_attrs(cx, Some(it.hir_id), &it.attrs, it.span, article, desc);
 468     }
 469
 470     fn check_trait_item(&mut self, cx: &LateContext<'_, '_>, trait_item: &hir::TraitItem<'_>) {
 471         if self.private_traits.contains(&trait_item.hir_id) {
 472             return;
 473         }
 474
 475         let def_id = cx.tcx.hir().local_def_id(trait_item.hir_id);
 476         let (article, desc) = cx.tcx.article_and_description(def_id.to_def_id());
 477
 478         self.check_missing_docs_attrs(
 479             cx,
 480             Some(trait_item.hir_id),
 481             &trait_item.attrs,
 482             trait_item.span,
 483             article,
 484             desc,
 485         );
 486     }
 487
 488     fn check_impl_item(&mut self, cx: &LateContext<'_, '_>, impl_item: &hir::ImplItem<'_>) {
 489         // If the method is an impl for a trait, don't doc.
 490         if method_context(cx, impl_item.hir_id) == MethodLateContext::TraitImpl {
 491             return;
 492         }
 493
 494         let def_id = cx.tcx.hir().local_def_id(impl_item.hir_id);
 495         let (article, desc) = cx.tcx.article_and_description(def_id.to_def_id());
 496         self.check_missing_docs_attrs(
 497             cx,
 498             Some(impl_item.hir_id),
 499             &impl_item.attrs,
 500             impl_item.span,
 501             article,
 502             desc,
 503         );
 504     }
 505
 506     fn check_struct_field(&mut self, cx: &LateContext<'_, '_>, sf: &hir::StructField<'_>) {
 507         if !sf.is_positional() {
 508             self.check_missing_docs_attrs(
 509                 cx,
 510                 Some(sf.hir_id),
 511                 &sf.attrs,
 512                 sf.span,
 513                 "a",
 514                 "struct field",
 515             )
 516         }
 517     }
 518
 519     fn check_variant(&mut self, cx: &LateContext<'_, '_>, v: &hir::Variant<'_>) {
 520         self.check_missing_docs_attrs(cx, Some(v.id), &v.attrs, v.span, "a", "variant");
 521     }
 522 }
 523
 524 declare_lint! {
 525     pub MISSING_COPY_IMPLEMENTATIONS,
 526     Allow,
 527     "detects potentially-forgotten implementations of `Copy`"
 528 }
 529
 530 declare_lint_pass!(MissingCopyImplementations => [MISSING_COPY_IMPLEMENTATIONS]);
 531
 532 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MissingCopyImplementations {
 533     fn check_item(&mut self, cx: &LateContext<'_, '_>, item: &hir::Item<'_>) {
 534         if !cx.access_levels.is_reachable(item.hir_id) {
 535             return;
 536         }
 537         let (def, ty) = match item.kind {
 538             hir::ItemKind::Struct(_, ref ast_generics) => {
 539                 if !ast_generics.params.is_empty() {
 540                     return;
 541                 }
 542                 let def = cx.tcx.adt_def(cx.tcx.hir().local_def_id(item.hir_id));
 543                 (def, cx.tcx.mk_adt(def, cx.tcx.intern_substs(&[])))
 544             }
 545             hir::ItemKind::Union(_, ref ast_generics) => {
 546                 if !ast_generics.params.is_empty() {
 547                     return;
 548                 }
 549                 let def = cx.tcx.adt_def(cx.tcx.hir().local_def_id(item.hir_id));
 550                 (def, cx.tcx.mk_adt(def, cx.tcx.intern_substs(&[])))
 551             }
 552             hir::ItemKind::Enum(_, ref ast_generics) => {
 553                 if !ast_generics.params.is_empty() {
 554                     return;
 555                 }
 556                 let def = cx.tcx.adt_def(cx.tcx.hir().local_def_id(item.hir_id));
 557                 (def, cx.tcx.mk_adt(def, cx.tcx.intern_substs(&[])))
 558             }
 559             _ => return,
 560         };
 561         if def.has_dtor(cx.tcx) {
 562             return;
 563         }
 564         let param_env = ty::ParamEnv::empty();
 565         if ty.is_copy_modulo_regions(cx.tcx, param_env, item.span) {
 566             return;
 567         }
 568         if can_type_implement_copy(cx.tcx, param_env, ty).is_ok() {
 569             cx.struct_span_lint(MISSING_COPY_IMPLEMENTATIONS, item.span, |lint| {
 570                 lint.build(
 571                     "type could implement `Copy`; consider adding `impl \
 572                           Copy`",
 573                 )
 574                 .emit()
 575             })
 576         }
 577     }
 578 }
 579
 580 declare_lint! {
 581     MISSING_DEBUG_IMPLEMENTATIONS,
 582     Allow,
 583     "detects missing implementations of Debug"
 584 }
 585
 586 #[derive(Default)]
 587 pub struct MissingDebugImplementations {
 588     impling_types: Option<HirIdSet>,
 589 }
 590
 591 impl_lint_pass!(MissingDebugImplementations => [MISSING_DEBUG_IMPLEMENTATIONS]);
 592
 593 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MissingDebugImplementations {
 594     fn check_item(&mut self, cx: &LateContext<'_, '_>, item: &hir::Item<'_>) {
 595         if !cx.access_levels.is_reachable(item.hir_id) {
 596             return;
 597         }
 598
 599         match item.kind {
 600             hir::ItemKind::Struct(..) | hir::ItemKind::Union(..) | hir::ItemKind::Enum(..) => {}
 601             _ => return,
 602         }
 603
 604         let debug = match cx.tcx.get_diagnostic_item(sym::debug_trait) {
 605             Some(debug) => debug,
 606             None => return,
 607         };
 608
 609         if self.impling_types.is_none() {
 610             let mut impls = HirIdSet::default();
 611             cx.tcx.for_each_impl(debug, |d| {
 612                 if let Some(ty_def) = cx.tcx.type_of(d).ty_adt_def() {
 613                     if let Some(def_id) = ty_def.did.as_local() {
 614                         impls.insert(cx.tcx.hir().as_local_hir_id(def_id));
 615                     }
 616                 }
 617             });
 618
 619             self.impling_types = Some(impls);
 620             debug!("{:?}", self.impling_types);
 621         }
 622
 623         if !self.impling_types.as_ref().unwrap().contains(&item.hir_id) {
 624             cx.struct_span_lint(MISSING_DEBUG_IMPLEMENTATIONS, item.span, |lint| {
 625                 lint.build(&format!(
 626                     "type does not implement `{}`; consider adding `#[derive(Debug)]` \
 627                      or a manual implementation",
 628                     cx.tcx.def_path_str(debug)
 629                 ))
 630                 .emit()
 631             });
 632         }
 633     }
 634 }
 635
 636 declare_lint! {
 637     pub ANONYMOUS_PARAMETERS,
 638     Allow,
 639     "detects anonymous parameters",
 640     @future_incompatible = FutureIncompatibleInfo {
 641         reference: "issue #41686 <https://github.com/rust-lang/rust/issues/41686>",
 642         edition: Some(Edition::Edition2018),
 643     };
 644 }
 645
 646 declare_lint_pass!(
 647     /// Checks for use of anonymous parameters (RFC 1685).
 648     AnonymousParameters => [ANONYMOUS_PARAMETERS]
 649 );
 650
 651 impl EarlyLintPass for AnonymousParameters {
 652     fn check_trait_item(&mut self, cx: &EarlyContext<'_>, it: &ast::AssocItem) {
 653         if let ast::AssocItemKind::Fn(_, ref sig, _, _) = it.kind {
 654             for arg in sig.decl.inputs.iter() {
 655                 if let ast::PatKind::Ident(_, ident, None) = arg.pat.kind {
 656                     if ident.name == kw::Invalid {
 657                         cx.struct_span_lint(ANONYMOUS_PARAMETERS, arg.pat.span, |lint| {
 658                             let ty_snip = cx.sess.source_map().span_to_snippet(arg.ty.span);
 659
 660                             let (ty_snip, appl) = if let Ok(ref snip) = ty_snip {
 661                                 (snip.as_str(), Applicability::MachineApplicable)
 662                             } else {
 663                                 ("<type>", Applicability::HasPlaceholders)
 664                             };
 665
 666                             lint.build(
 667                                 "anonymous parameters are deprecated and will be \
 668                                      removed in the next edition.",
 669                             )
 670                             .span_suggestion(
 671                                 arg.pat.span,
 672                                 "try naming the parameter or explicitly \
 673                                             ignoring it",
 674                                 format!("_: {}", ty_snip),
 675                                 appl,
 676                             )
 677                             .emit();
 678                         })
 679                     }
 680                 }
 681             }
 682         }
 683     }
 684 }
 685
 686 /// Check for use of attributes which have been deprecated.
 687 #[derive(Clone)]
 688 pub struct DeprecatedAttr {
 689     // This is not free to compute, so we want to keep it around, rather than
 690     // compute it for every attribute.
 691     depr_attrs: Vec<&'static (Symbol, AttributeType, AttributeTemplate, AttributeGate)>,
 692 }
 693
 694 impl_lint_pass!(DeprecatedAttr => []);
 695
 696 impl DeprecatedAttr {
 697     pub fn new() -> DeprecatedAttr {
 698         DeprecatedAttr { depr_attrs: deprecated_attributes() }
 699     }
 700 }
 701
 702 fn lint_deprecated_attr(
 703     cx: &EarlyContext<'_>,
 704     attr: &ast::Attribute,
 705     msg: &str,
 706     suggestion: Option<&str>,
 707 ) {
 708     cx.struct_span_lint(DEPRECATED, attr.span, |lint| {
 709         lint.build(msg)
 710             .span_suggestion_short(
 711                 attr.span,
 712                 suggestion.unwrap_or("remove this attribute"),
 713                 String::new(),
 714                 Applicability::MachineApplicable,
 715             )
 716             .emit();
 717     })
 718 }
 719
 720 impl EarlyLintPass for DeprecatedAttr {
 721     fn check_attribute(&mut self, cx: &EarlyContext<'_>, attr: &ast::Attribute) {
 722         for &&(n, _, _, ref g) in &self.depr_attrs {
 723             if attr.ident().map(|ident| ident.name) == Some(n) {
 724                 if let &AttributeGate::Gated(
 725                     Stability::Deprecated(link, suggestion),
 726                     ref name,
 727                     ref reason,
 728                     _,
 729                 ) = g
 730                 {
 731                     let msg =
 732                         format!("use of deprecated attribute `{}`: {}. See {}", name, reason, link);
 733                     lint_deprecated_attr(cx, attr, &msg, suggestion);
 734                 }
 735                 return;
 736             }
 737         }
 738         if attr.check_name(sym::no_start) || attr.check_name(sym::crate_id) {
 739             let path_str = pprust::path_to_string(&attr.get_normal_item().path);
 740             let msg = format!("use of deprecated attribute `{}`: no longer used.", path_str);
 741             lint_deprecated_attr(cx, attr, &msg, None);
 742         }
 743     }
 744 }
 745
 746 fn warn_if_doc(cx: &EarlyContext<'_>, node_span: Span, node_kind: &str, attrs: &[ast::Attribute]) {
 747     let mut attrs = attrs.iter().peekable();
 748
 749     // Accumulate a single span for sugared doc comments.
 750     let mut sugared_span: Option<Span> = None;
 751
 752     while let Some(attr) = attrs.next() {
 753         if attr.is_doc_comment() {
 754             sugared_span =
 755                 Some(sugared_span.map_or_else(|| attr.span, |span| span.with_hi(attr.span.hi())));
 756         }
 757
 758         if attrs.peek().map(|next_attr| next_attr.is_doc_comment()).unwrap_or_default() {
 759             continue;
 760         }
 761
 762         let span = sugared_span.take().unwrap_or_else(|| attr.span);
 763
 764         if attr.is_doc_comment() || attr.check_name(sym::doc) {
 765             cx.struct_span_lint(UNUSED_DOC_COMMENTS, span, |lint| {
 766                 let mut err = lint.build("unused doc comment");
 767                 err.span_label(
 768                     node_span,
 769                     format!("rustdoc does not generate documentation for {}", node_kind),
 770                 );
 771                 err.emit();
 772             });
 773         }
 774     }
 775 }
 776
 777 impl EarlyLintPass for UnusedDocComment {
 778     fn check_stmt(&mut self, cx: &EarlyContext<'_>, stmt: &ast::Stmt) {
 779         let kind = match stmt.kind {
 780             ast::StmtKind::Local(..) => "statements",
 781             ast::StmtKind::Item(..) => "inner items",
 782             // expressions will be reported by `check_expr`.
 783             ast::StmtKind::Empty
 784             | ast::StmtKind::Semi(_)
 785             | ast::StmtKind::Expr(_)
 786             | ast::StmtKind::MacCall(_) => return,
 787         };
 788
 789         warn_if_doc(cx, stmt.span, kind, stmt.kind.attrs());
 790     }
 791
 792     fn check_arm(&mut self, cx: &EarlyContext<'_>, arm: &ast::Arm) {
 793         let arm_span = arm.pat.span.with_hi(arm.body.span.hi());
 794         warn_if_doc(cx, arm_span, "match arms", &arm.attrs);
 795     }
 796
 797     fn check_expr(&mut self, cx: &EarlyContext<'_>, expr: &ast::Expr) {
 798         warn_if_doc(cx, expr.span, "expressions", &expr.attrs);
 799     }
 800 }
 801
 802 declare_lint! {
 803     NO_MANGLE_CONST_ITEMS,
 804     Deny,
 805     "const items will not have their symbols exported"
 806 }
 807
 808 declare_lint! {
 809     NO_MANGLE_GENERIC_ITEMS,
 810     Warn,
 811     "generic items must be mangled"
 812 }
 813
 814 declare_lint_pass!(InvalidNoMangleItems => [NO_MANGLE_CONST_ITEMS, NO_MANGLE_GENERIC_ITEMS]);
 815
 816 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for InvalidNoMangleItems {
 817     fn check_item(&mut self, cx: &LateContext<'_, '_>, it: &hir::Item<'_>) {
 818         match it.kind {
 819             hir::ItemKind::Fn(.., ref generics, _) => {
 820                 if let Some(no_mangle_attr) = attr::find_by_name(&it.attrs, sym::no_mangle) {
 821                     for param in generics.params {
 822                         match param.kind {
 823                             GenericParamKind::Lifetime { .. } => {}
 824                             GenericParamKind::Type { .. } | GenericParamKind::Const { .. } => {
 825                                 cx.struct_span_lint(NO_MANGLE_GENERIC_ITEMS, it.span, |lint| {
 826                                     lint.build(
 827                                         "functions generic over types or consts must be mangled",
 828                                     )
 829                                     .span_suggestion_short(
 830                                         no_mangle_attr.span,
 831                                         "remove this attribute",
 832                                         String::new(),
 833                                         // Use of `#[no_mangle]` suggests FFI intent; correct
 834                                         // fix may be to monomorphize source by hand
 835                                         Applicability::MaybeIncorrect,
 836                                     )
 837                                     .emit();
 838                                 });
 839                                 break;
 840                             }
 841                         }
 842                     }
 843                 }
 844             }
 845             hir::ItemKind::Const(..) => {
 846                 if attr::contains_name(&it.attrs, sym::no_mangle) {
 847                     // Const items do not refer to a particular location in memory, and therefore
 848                     // don't have anything to attach a symbol to
 849                     cx.struct_span_lint(NO_MANGLE_CONST_ITEMS, it.span, |lint| {
 850                         let msg = "const items should never be `#[no_mangle]`";
 851                         let mut err = lint.build(msg);
 852
 853                         // account for "pub const" (#45562)
 854                         let start = cx
 855                             .tcx
 856                             .sess
 857                             .source_map()
 858                             .span_to_snippet(it.span)
 859                             .map(|snippet| snippet.find("const").unwrap_or(0))
 860                             .unwrap_or(0) as u32;
 861                         // `const` is 5 chars
 862                         let const_span = it.span.with_hi(BytePos(it.span.lo().0 + start + 5));
 863                         err.span_suggestion(
 864                             const_span,
 865                             "try a static value",
 866                             "pub static".to_owned(),
 867                             Applicability::MachineApplicable,
 868                         );
 869                         err.emit();
 870                     });
 871                 }
 872             }
 873             _ => {}
 874         }
 875     }
 876 }
 877
 878 declare_lint! {
 879     MUTABLE_TRANSMUTES,
 880     Deny,
 881     "mutating transmuted &mut T from &T may cause undefined behavior"
 882 }
 883
 884 declare_lint_pass!(MutableTransmutes => [MUTABLE_TRANSMUTES]);
 885
 886 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MutableTransmutes {
 887     fn check_expr(&mut self, cx: &LateContext<'_, '_>, expr: &hir::Expr<'_>) {
 888         use rustc_target::spec::abi::Abi::RustIntrinsic;
 889         if let Some((&ty::Ref(_, _, from_mt), &ty::Ref(_, _, to_mt))) =
 890             get_transmute_from_to(cx, expr).map(|(ty1, ty2)| (&ty1.kind, &ty2.kind))
 891         {
 892             if to_mt == hir::Mutability::Mut && from_mt == hir::Mutability::Not {
 893                 let msg = "mutating transmuted &mut T from &T may cause undefined behavior, \
 894                                consider instead using an UnsafeCell";
 895                 cx.struct_span_lint(MUTABLE_TRANSMUTES, expr.span, |lint| lint.build(msg).emit());
 896             }
 897         }
 898
 899         fn get_transmute_from_to<'a, 'tcx>(
 900             cx: &LateContext<'a, 'tcx>,
 901             expr: &hir::Expr<'_>,
 902         ) -> Option<(Ty<'tcx>, Ty<'tcx>)> {
 903             let def = if let hir::ExprKind::Path(ref qpath) = expr.kind {
 904                 cx.tables.qpath_res(qpath, expr.hir_id)
 905             } else {
 906                 return None;
 907             };
 908             if let Res::Def(DefKind::Fn, did) = def {
 909                 if !def_id_is_transmute(cx, did) {
 910                     return None;
 911                 }
 912                 let sig = cx.tables.node_type(expr.hir_id).fn_sig(cx.tcx);
 913                 let from = sig.inputs().skip_binder()[0];
 914                 let to = *sig.output().skip_binder();
 915                 return Some((from, to));
 916             }
 917             None
 918         }
 919
 920         fn def_id_is_transmute(cx: &LateContext<'_, '_>, def_id: DefId) -> bool {
 921             cx.tcx.fn_sig(def_id).abi() == RustIntrinsic
 922                 && cx.tcx.item_name(def_id) == sym::transmute
 923         }
 924     }
 925 }
 926
 927 declare_lint! {
 928     UNSTABLE_FEATURES,
 929     Allow,
 930     "enabling unstable features (deprecated. do not use)"
 931 }
 932
 933 declare_lint_pass!(
 934     /// Forbids using the `#[feature(...)]` attribute
 935     UnstableFeatures => [UNSTABLE_FEATURES]
 936 );
 937
 938 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnstableFeatures {
 939     fn check_attribute(&mut self, ctx: &LateContext<'_, '_>, attr: &ast::Attribute) {
 940         if attr.check_name(sym::feature) {
 941             if let Some(items) = attr.meta_item_list() {
 942                 for item in items {
 943                     ctx.struct_span_lint(UNSTABLE_FEATURES, item.span(), |lint| {
 944                         lint.build("unstable feature").emit()
 945                     });
 946                 }
 947             }
 948         }
 949     }
 950 }
 951
 952 declare_lint! {
 953     pub UNREACHABLE_PUB,
 954     Allow,
 955     "`pub` items not reachable from crate root"
 956 }
 957
 958 declare_lint_pass!(
 959     /// Lint for items marked `pub` that aren't reachable from other crates.
 960     UnreachablePub => [UNREACHABLE_PUB]
 961 );
 962
 963 impl UnreachablePub {
 964     fn perform_lint(
 965         &self,
 966         cx: &LateContext<'_, '_>,
 967         what: &str,
 968         id: hir::HirId,
 969         vis: &hir::Visibility<'_>,
 970         span: Span,
 971         exportable: bool,
 972     ) {
 973         let mut applicability = Applicability::MachineApplicable;
 974         match vis.node {
 975             hir::VisibilityKind::Public if !cx.access_levels.is_reachable(id) => {
 976                 if span.from_expansion() {
 977                     applicability = Applicability::MaybeIncorrect;
 978                 }
 979                 let def_span = cx.tcx.sess.source_map().guess_head_span(span);
 980                 cx.struct_span_lint(UNREACHABLE_PUB, def_span, |lint| {
 981                     let mut err = lint.build(&format!("unreachable `pub` {}", what));
 982                     let replacement = if cx.tcx.features().crate_visibility_modifier {
 983                         "crate"
 984                     } else {
 985                         "pub(crate)"
 986                     }
 987                     .to_owned();
 988
 989                     err.span_suggestion(
 990                         vis.span,
 991                         "consider restricting its visibility",
 992                         replacement,
 993                         applicability,
 994                     );
 995                     if exportable {
 996                         err.help("or consider exporting it for use by other crates");
 997                     }
 998                     err.emit();
 999                 });
1000             }
1001             _ => {}
1002         }
1003     }
1004 }
1005
1006 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnreachablePub {
1007     fn check_item(&mut self, cx: &LateContext<'_, '_>, item: &hir::Item<'_>) {
1008         self.perform_lint(cx, "item", item.hir_id, &item.vis, item.span, true);
1009     }
1010
1011     fn check_foreign_item(
1012         &mut self,
1013         cx: &LateContext<'_, '_>,
1014         foreign_item: &hir::ForeignItem<'tcx>,
1015     ) {
1016         self.perform_lint(
1017             cx,
1018             "item",
1019             foreign_item.hir_id,
1020             &foreign_item.vis,
1021             foreign_item.span,
1022             true,
1023         );
1024     }
1025
1026     fn check_struct_field(&mut self, cx: &LateContext<'_, '_>, field: &hir::StructField<'_>) {
1027         self.perform_lint(cx, "field", field.hir_id, &field.vis, field.span, false);
1028     }
1029
1030     fn check_impl_item(&mut self, cx: &LateContext<'_, '_>, impl_item: &hir::ImplItem<'_>) {
1031         self.perform_lint(cx, "item", impl_item.hir_id, &impl_item.vis, impl_item.span, false);
1032     }
1033 }
1034
1035 declare_lint! {
1036     TYPE_ALIAS_BOUNDS,
1037     Warn,
1038     "bounds in type aliases are not enforced"
1039 }
1040
1041 declare_lint_pass!(
1042     /// Lint for trait and lifetime bounds in type aliases being mostly ignored.
1043     /// They are relevant when using associated types, but otherwise neither checked
1044     /// at definition site nor enforced at use site.
1045     TypeAliasBounds => [TYPE_ALIAS_BOUNDS]
1046 );
1047
1048 impl TypeAliasBounds {
1049     fn is_type_variable_assoc(qpath: &hir::QPath<'_>) -> bool {
1050         match *qpath {
1051             hir::QPath::TypeRelative(ref ty, _) => {
1052                 // If this is a type variable, we found a `T::Assoc`.
1053                 match ty.kind {
1054                     hir::TyKind::Path(hir::QPath::Resolved(None, ref path)) => match path.res {
1055                         Res::Def(DefKind::TyParam, _) => true,
1056                         _ => false,
1057                     },
1058                     _ => false,
1059                 }
1060             }
1061             hir::QPath::Resolved(..) => false,
1062         }
1063     }
1064
1065     fn suggest_changing_assoc_types(ty: &hir::Ty<'_>, err: &mut DiagnosticBuilder<'_>) {
1066         // Access to associates types should use `<T as Bound>::Assoc`, which does not need a
1067         // bound.  Let's see if this type does that.
1068
1069         // We use a HIR visitor to walk the type.
1070         use rustc_hir::intravisit::{self, Visitor};
1071         struct WalkAssocTypes<'a, 'db> {
1072             err: &'a mut DiagnosticBuilder<'db>,
1073         }
1074         impl<'a, 'db, 'v> Visitor<'v> for WalkAssocTypes<'a, 'db> {
1075             type Map = intravisit::ErasedMap<'v>;
1076
1077             fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<Self::Map> {
1078                 intravisit::NestedVisitorMap::None
1079             }
1080
1081             fn visit_qpath(&mut self, qpath: &'v hir::QPath<'v>, id: hir::HirId, span: Span) {
1082                 if TypeAliasBounds::is_type_variable_assoc(qpath) {
1083                     self.err.span_help(
1084                         span,
1085                         "use fully disambiguated paths (i.e., `<T as Trait>::Assoc`) to refer to \
1086                          associated types in type aliases",
1087                     );
1088                 }
1089                 intravisit::walk_qpath(self, qpath, id, span)
1090             }
1091         }
1092
1093         // Let's go for a walk!
1094         let mut visitor = WalkAssocTypes { err };
1095         visitor.visit_ty(ty);
1096     }
1097 }
1098
1099 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for TypeAliasBounds {
1100     fn check_item(&mut self, cx: &LateContext<'_, '_>, item: &hir::Item<'_>) {
1101         let (ty, type_alias_generics) = match item.kind {
1102             hir::ItemKind::TyAlias(ref ty, ref generics) => (&*ty, generics),
1103             _ => return,
1104         };
1105         let mut suggested_changing_assoc_types = false;
1106         // There must not be a where clause
1107         if !type_alias_generics.where_clause.predicates.is_empty() {
1108             cx.lint(
1109                 TYPE_ALIAS_BOUNDS,
1110                 |lint| {
1111                     let mut err = lint.build("where clauses are not enforced in type aliases");
1112                     let spans: Vec<_> = type_alias_generics
1113                         .where_clause
1114                         .predicates
1115                         .iter()
1116                         .map(|pred| pred.span())
1117                         .collect();
1118                     err.set_span(spans);
1119                     err.span_suggestion(
1120                         type_alias_generics.where_clause.span_for_predicates_or_empty_place(),
1121                         "the clause will not be checked when the type alias is used, and should be removed",
1122                         String::new(),
1123                         Applicability::MachineApplicable,
1124                     );
1125                     if !suggested_changing_assoc_types {
1126                         TypeAliasBounds::suggest_changing_assoc_types(ty, &mut err);
1127                         suggested_changing_assoc_types = true;
1128                     }
1129                     err.emit();
1130                 },
1131             );
1132         }
1133         // The parameters must not have bounds
1134         for param in type_alias_generics.params.iter() {
1135             let spans: Vec<_> = param.bounds.iter().map(|b| b.span()).collect();
1136             let suggestion = spans
1137                 .iter()
1138                 .map(|sp| {
1139                     let start = param.span.between(*sp); // Include the `:` in `T: Bound`.
1140                     (start.to(*sp), String::new())
1141                 })
1142                 .collect();
1143             if !spans.is_empty() {
1144                 cx.struct_span_lint(TYPE_ALIAS_BOUNDS, spans, |lint| {
1145                     let mut err =
1146                         lint.build("bounds on generic parameters are not enforced in type aliases");
1147                     let msg = "the bound will not be checked when the type alias is used, \
1148                                    and should be removed";
1149                     err.multipart_suggestion(&msg, suggestion, Applicability::MachineApplicable);
1150                     if !suggested_changing_assoc_types {
1151                         TypeAliasBounds::suggest_changing_assoc_types(ty, &mut err);
1152                         suggested_changing_assoc_types = true;
1153                     }
1154                     err.emit();
1155                 });
1156             }
1157         }
1158     }
1159 }
1160
1161 declare_lint_pass!(
1162     /// Lint constants that are erroneous.
1163     /// Without this lint, we might not get any diagnostic if the constant is
1164     /// unused within this crate, even though downstream crates can't use it
1165     /// without producing an error.
1166     UnusedBrokenConst => []
1167 );
1168
1169 fn check_const(cx: &LateContext<'_, '_>, body_id: hir::BodyId) {
1170     let def_id = cx.tcx.hir().body_owner_def_id(body_id).to_def_id();
1171     // trigger the query once for all constants since that will already report the errors
1172     // FIXME: Use ensure here
1173     let _ = cx.tcx.const_eval_poly(def_id);
1174 }
1175
1176 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnusedBrokenConst {
1177     fn check_item(&mut self, cx: &LateContext<'_, '_>, it: &hir::Item<'_>) {
1178         match it.kind {
1179             hir::ItemKind::Const(_, body_id) => {
1180                 check_const(cx, body_id);
1181             }
1182             hir::ItemKind::Static(_, _, body_id) => {
1183                 check_const(cx, body_id);
1184             }
1185             _ => {}
1186         }
1187     }
1188 }
1189
1190 declare_lint! {
1191     TRIVIAL_BOUNDS,
1192     Warn,
1193     "these bounds don't depend on an type parameters"
1194 }
1195
1196 declare_lint_pass!(
1197     /// Lint for trait and lifetime bounds that don't depend on type parameters
1198     /// which either do nothing, or stop the item from being used.
1199     TrivialConstraints => [TRIVIAL_BOUNDS]
1200 );
1201
1202 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for TrivialConstraints {
1203     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx hir::Item<'tcx>) {
1204         use rustc_middle::ty::fold::TypeFoldable;
1205         use rustc_middle::ty::PredicateKind::*;
1206
1207         if cx.tcx.features().trivial_bounds {
1208             let def_id = cx.tcx.hir().local_def_id(item.hir_id);
1209             let predicates = cx.tcx.predicates_of(def_id);
1210             for &(predicate, span) in predicates.predicates {
1211                 let predicate_kind_name = match predicate.kind() {
1212                     Trait(..) => "Trait",
1213                     TypeOutlives(..) |
1214                     RegionOutlives(..) => "Lifetime",
1215
1216                     // Ignore projections, as they can only be global
1217                     // if the trait bound is global
1218                     Projection(..) |
1219                     // Ignore bounds that a user can't type
1220                     WellFormed(..) |
1221                     ObjectSafe(..) |
1222                     ClosureKind(..) |
1223                     Subtype(..) |
1224                     ConstEvaluatable(..) |
1225                     ConstEquate(..) => continue,
1226                 };
1227                 if predicate.is_global() {
1228                     cx.struct_span_lint(TRIVIAL_BOUNDS, span, |lint| {
1229                         lint.build(&format!(
1230                             "{} bound {} does not depend on any type \
1231                                 or lifetime parameters",
1232                             predicate_kind_name, predicate
1233                         ))
1234                         .emit()
1235                     });
1236                 }
1237             }
1238         }
1239     }
1240 }
1241
1242 declare_lint_pass!(
1243     /// Does nothing as a lint pass, but registers some `Lint`s
1244     /// which are used by other parts of the compiler.
1245     SoftLints => [
1246         WHILE_TRUE,
1247         BOX_POINTERS,
1248         NON_SHORTHAND_FIELD_PATTERNS,
1249         UNSAFE_CODE,
1250         MISSING_DOCS,
1251         MISSING_COPY_IMPLEMENTATIONS,
1252         MISSING_DEBUG_IMPLEMENTATIONS,
1253         ANONYMOUS_PARAMETERS,
1254         UNUSED_DOC_COMMENTS,
1255         NO_MANGLE_CONST_ITEMS,
1256         NO_MANGLE_GENERIC_ITEMS,
1257         MUTABLE_TRANSMUTES,
1258         UNSTABLE_FEATURES,
1259         UNREACHABLE_PUB,
1260         TYPE_ALIAS_BOUNDS,
1261         TRIVIAL_BOUNDS
1262     ]
1263 );
1264
1265 declare_lint! {
1266     pub ELLIPSIS_INCLUSIVE_RANGE_PATTERNS,
1267     Warn,
1268     "`...` range patterns are deprecated"
1269 }
1270
1271 #[derive(Default)]
1272 pub struct EllipsisInclusiveRangePatterns {
1273     /// If `Some(_)`, suppress all subsequent pattern
1274     /// warnings for better diagnostics.
1275     node_id: Option<ast::NodeId>,
1276 }
1277
1278 impl_lint_pass!(EllipsisInclusiveRangePatterns => [ELLIPSIS_INCLUSIVE_RANGE_PATTERNS]);
1279
1280 impl EarlyLintPass for EllipsisInclusiveRangePatterns {
1281     fn check_pat(&mut self, cx: &EarlyContext<'_>, pat: &ast::Pat) {
1282         if self.node_id.is_some() {
1283             // Don't recursively warn about patterns inside range endpoints.
1284             return;
1285         }
1286
1287         use self::ast::{PatKind, RangeEnd, RangeSyntax::DotDotDot};
1288
1289         /// If `pat` is a `...` pattern, return the start and end of the range, as well as the span
1290         /// corresponding to the ellipsis.
1291         fn matches_ellipsis_pat(pat: &ast::Pat) -> Option<(Option<&Expr>, &Expr, Span)> {
1292             match &pat.kind {
1293                 PatKind::Range(
1294                     a,
1295                     Some(b),
1296                     Spanned { span, node: RangeEnd::Included(DotDotDot) },
1297                 ) => Some((a.as_deref(), b, *span)),
1298                 _ => None,
1299             }
1300         }
1301
1302         let (parenthesise, endpoints) = match &pat.kind {
1303             PatKind::Ref(subpat, _) => (true, matches_ellipsis_pat(&subpat)),
1304             _ => (false, matches_ellipsis_pat(pat)),
1305         };
1306
1307         if let Some((start, end, join)) = endpoints {
1308             let msg = "`...` range patterns are deprecated";
1309             let suggestion = "use `..=` for an inclusive range";
1310             if parenthesise {
1311                 self.node_id = Some(pat.id);
1312                 cx.struct_span_lint(ELLIPSIS_INCLUSIVE_RANGE_PATTERNS, pat.span, |lint| {
1313                     let end = expr_to_string(&end);
1314                     let replace = match start {
1315                         Some(start) => format!("&({}..={})", expr_to_string(&start), end),
1316                         None => format!("&(..={})", end),
1317                     };
1318                     lint.build(msg)
1319                         .span_suggestion(
1320                             pat.span,
1321                             suggestion,
1322                             replace,
1323                             Applicability::MachineApplicable,
1324                         )
1325                         .emit();
1326                 });
1327             } else {
1328                 cx.struct_span_lint(ELLIPSIS_INCLUSIVE_RANGE_PATTERNS, join, |lint| {
1329                     lint.build(msg)
1330                         .span_suggestion_short(
1331                             join,
1332                             suggestion,
1333                             "..=".to_owned(),
1334                             Applicability::MachineApplicable,
1335                         )
1336                         .emit();
1337                 });
1338             };
1339         }
1340     }
1341
1342     fn check_pat_post(&mut self, _cx: &EarlyContext<'_>, pat: &ast::Pat) {
1343         if let Some(node_id) = self.node_id {
1344             if pat.id == node_id {
1345                 self.node_id = None
1346             }
1347         }
1348     }
1349 }
1350
1351 declare_lint! {
1352     UNNAMEABLE_TEST_ITEMS,
1353     Warn,
1354     "detects an item that cannot be named being marked as `#[test_case]`",
1355     report_in_external_macro
1356 }
1357
1358 pub struct UnnameableTestItems {
1359     boundary: Option<hir::HirId>, // HirId of the item under which things are not nameable
1360     items_nameable: bool,
1361 }
1362
1363 impl_lint_pass!(UnnameableTestItems => [UNNAMEABLE_TEST_ITEMS]);
1364
1365 impl UnnameableTestItems {
1366     pub fn new() -> Self {
1367         Self { boundary: None, items_nameable: true }
1368     }
1369 }
1370
1371 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnnameableTestItems {
1372     fn check_item(&mut self, cx: &LateContext<'_, '_>, it: &hir::Item<'_>) {
1373         if self.items_nameable {
1374             if let hir::ItemKind::Mod(..) = it.kind {
1375             } else {
1376                 self.items_nameable = false;
1377                 self.boundary = Some(it.hir_id);
1378             }
1379             return;
1380         }
1381
1382         if let Some(attr) = attr::find_by_name(&it.attrs, sym::rustc_test_marker) {
1383             cx.struct_span_lint(UNNAMEABLE_TEST_ITEMS, attr.span, |lint| {
1384                 lint.build("cannot test inner items").emit()
1385             });
1386         }
1387     }
1388
1389     fn check_item_post(&mut self, _cx: &LateContext<'_, '_>, it: &hir::Item<'_>) {
1390         if !self.items_nameable && self.boundary == Some(it.hir_id) {
1391             self.items_nameable = true;
1392         }
1393     }
1394 }
1395
1396 declare_lint! {
1397     pub KEYWORD_IDENTS,
1398     Allow,
1399     "detects edition keywords being used as an identifier",
1400     @future_incompatible = FutureIncompatibleInfo {
1401         reference: "issue #49716 <https://github.com/rust-lang/rust/issues/49716>",
1402         edition: Some(Edition::Edition2018),
1403     };
1404 }
1405
1406 declare_lint_pass!(
1407     /// Check for uses of edition keywords used as an identifier.
1408     KeywordIdents => [KEYWORD_IDENTS]
1409 );
1410
1411 struct UnderMacro(bool);
1412
1413 impl KeywordIdents {
1414     fn check_tokens(&mut self, cx: &EarlyContext<'_>, tokens: TokenStream) {
1415         for tt in tokens.into_trees() {
1416             match tt {
1417                 // Only report non-raw idents.
1418                 TokenTree::Token(token) => {
1419                     if let Some((ident, false)) = token.ident() {
1420                         self.check_ident_token(cx, UnderMacro(true), ident);
1421                     }
1422                 }
1423                 TokenTree::Delimited(_, _, tts) => self.check_tokens(cx, tts),
1424             }
1425         }
1426     }
1427
1428     fn check_ident_token(
1429         &mut self,
1430         cx: &EarlyContext<'_>,
1431         UnderMacro(under_macro): UnderMacro,
1432         ident: Ident,
1433     ) {
1434         let next_edition = match cx.sess.edition() {
1435             Edition::Edition2015 => {
1436                 match ident.name {
1437                     kw::Async | kw::Await | kw::Try => Edition::Edition2018,
1438
1439                     // rust-lang/rust#56327: Conservatively do not
1440                     // attempt to report occurrences of `dyn` within
1441                     // macro definitions or invocations, because `dyn`
1442                     // can legitimately occur as a contextual keyword
1443                     // in 2015 code denoting its 2018 meaning, and we
1444                     // do not want rustfix to inject bugs into working
1445                     // code by rewriting such occurrences.
1446                     //
1447                     // But if we see `dyn` outside of a macro, we know
1448                     // its precise role in the parsed AST and thus are
1449                     // assured this is truly an attempt to use it as
1450                     // an identifier.
1451                     kw::Dyn if !under_macro => Edition::Edition2018,
1452
1453                     _ => return,
1454                 }
1455             }
1456
1457             // There are no new keywords yet for the 2018 edition and beyond.
1458             _ => return,
1459         };
1460
1461         // Don't lint `r#foo`.
1462         if cx.sess.parse_sess.raw_identifier_spans.borrow().contains(&ident.span) {
1463             return;
1464         }
1465
1466         cx.struct_span_lint(KEYWORD_IDENTS, ident.span, |lint| {
1467             lint.build(&format!("`{}` is a keyword in the {} edition", ident, next_edition))
1468                 .span_suggestion(
1469                     ident.span,
1470                     "you can use a raw identifier to stay compatible",
1471                     format!("r#{}", ident),
1472                     Applicability::MachineApplicable,
1473                 )
1474                 .emit()
1475         });
1476     }
1477 }
1478
1479 impl EarlyLintPass for KeywordIdents {
1480     fn check_mac_def(&mut self, cx: &EarlyContext<'_>, mac_def: &ast::MacroDef, _id: ast::NodeId) {
1481         self.check_tokens(cx, mac_def.body.inner_tokens());
1482     }
1483     fn check_mac(&mut self, cx: &EarlyContext<'_>, mac: &ast::MacCall) {
1484         self.check_tokens(cx, mac.args.inner_tokens());
1485     }
1486     fn check_ident(&mut self, cx: &EarlyContext<'_>, ident: Ident) {
1487         self.check_ident_token(cx, UnderMacro(false), ident);
1488     }
1489 }
1490
1491 declare_lint_pass!(ExplicitOutlivesRequirements => [EXPLICIT_OUTLIVES_REQUIREMENTS]);
1492
1493 impl ExplicitOutlivesRequirements {
1494     fn lifetimes_outliving_lifetime<'tcx>(
1495         inferred_outlives: &'tcx [(ty::Predicate<'tcx>, Span)],
1496         index: u32,
1497     ) -> Vec<ty::Region<'tcx>> {
1498         inferred_outlives
1499             .iter()
1500             .filter_map(|(pred, _)| match pred.kind() {
1501                 ty::PredicateKind::RegionOutlives(outlives) => {
1502                     let outlives = outlives.skip_binder();
1503                     match outlives.0 {
1504                         ty::ReEarlyBound(ebr) if ebr.index == index => Some(outlives.1),
1505                         _ => None,
1506                     }
1507                 }
1508                 _ => None,
1509             })
1510             .collect()
1511     }
1512
1513     fn lifetimes_outliving_type<'tcx>(
1514         inferred_outlives: &'tcx [(ty::Predicate<'tcx>, Span)],
1515         index: u32,
1516     ) -> Vec<ty::Region<'tcx>> {
1517         inferred_outlives
1518             .iter()
1519             .filter_map(|(pred, _)| match pred.kind() {
1520                 ty::PredicateKind::TypeOutlives(outlives) => {
1521                     let outlives = outlives.skip_binder();
1522                     outlives.0.is_param(index).then_some(outlives.1)
1523                 }
1524                 _ => None,
1525             })
1526             .collect()
1527     }
1528
1529     fn collect_outlived_lifetimes<'tcx>(
1530         &self,
1531         param: &'tcx hir::GenericParam<'tcx>,
1532         tcx: TyCtxt<'tcx>,
1533         inferred_outlives: &'tcx [(ty::Predicate<'tcx>, Span)],
1534         ty_generics: &'tcx ty::Generics,
1535     ) -> Vec<ty::Region<'tcx>> {
1536         let index =
1537             ty_generics.param_def_id_to_index[&tcx.hir().local_def_id(param.hir_id).to_def_id()];
1538
1539         match param.kind {
1540             hir::GenericParamKind::Lifetime { .. } => {
1541                 Self::lifetimes_outliving_lifetime(inferred_outlives, index)
1542             }
1543             hir::GenericParamKind::Type { .. } => {
1544                 Self::lifetimes_outliving_type(inferred_outlives, index)
1545             }
1546             hir::GenericParamKind::Const { .. } => Vec::new(),
1547         }
1548     }
1549
1550     fn collect_outlives_bound_spans<'tcx>(
1551         &self,
1552         tcx: TyCtxt<'tcx>,
1553         bounds: &hir::GenericBounds<'_>,
1554         inferred_outlives: &[ty::Region<'tcx>],
1555         infer_static: bool,
1556     ) -> Vec<(usize, Span)> {
1557         use rustc_middle::middle::resolve_lifetime::Region;
1558
1559         bounds
1560             .iter()
1561             .enumerate()
1562             .filter_map(|(i, bound)| {
1563                 if let hir::GenericBound::Outlives(lifetime) = bound {
1564                     let is_inferred = match tcx.named_region(lifetime.hir_id) {
1565                         Some(Region::Static) if infer_static => inferred_outlives
1566                             .iter()
1567                             .any(|r| if let ty::ReStatic = r { true } else { false }),
1568                         Some(Region::EarlyBound(index, ..)) => inferred_outlives.iter().any(|r| {
1569                             if let ty::ReEarlyBound(ebr) = r { ebr.index == index } else { false }
1570                         }),
1571                         _ => false,
1572                     };
1573                     is_inferred.then_some((i, bound.span()))
1574                 } else {
1575                     None
1576                 }
1577             })
1578             .collect()
1579     }
1580
1581     fn consolidate_outlives_bound_spans(
1582         &self,
1583         lo: Span,
1584         bounds: &hir::GenericBounds<'_>,
1585         bound_spans: Vec<(usize, Span)>,
1586     ) -> Vec<Span> {
1587         if bounds.is_empty() {
1588             return Vec::new();
1589         }
1590         if bound_spans.len() == bounds.len() {
1591             let (_, last_bound_span) = bound_spans[bound_spans.len() - 1];
1592             // If all bounds are inferable, we want to delete the colon, so
1593             // start from just after the parameter (span passed as argument)
1594             vec![lo.to(last_bound_span)]
1595         } else {
1596             let mut merged = Vec::new();
1597             let mut last_merged_i = None;
1598
1599             let mut from_start = true;
1600             for (i, bound_span) in bound_spans {
1601                 match last_merged_i {
1602                     // If the first bound is inferable, our span should also eat the leading `+`.
1603                     None if i == 0 => {
1604                         merged.push(bound_span.to(bounds[1].span().shrink_to_lo()));
1605                         last_merged_i = Some(0);
1606                     }
1607                     // If consecutive bounds are inferable, merge their spans
1608                     Some(h) if i == h + 1 => {
1609                         if let Some(tail) = merged.last_mut() {
1610                             // Also eat the trailing `+` if the first
1611                             // more-than-one bound is inferable
1612                             let to_span = if from_start && i < bounds.len() {
1613                                 bounds[i + 1].span().shrink_to_lo()
1614                             } else {
1615                                 bound_span
1616                             };
1617                             *tail = tail.to(to_span);
1618                             last_merged_i = Some(i);
1619                         } else {
1620                             bug!("another bound-span visited earlier");
1621                         }
1622                     }
1623                     _ => {
1624                         // When we find a non-inferable bound, subsequent inferable bounds
1625                         // won't be consecutive from the start (and we'll eat the leading
1626                         // `+` rather than the trailing one)
1627                         from_start = false;
1628                         merged.push(bounds[i - 1].span().shrink_to_hi().to(bound_span));
1629                         last_merged_i = Some(i);
1630                     }
1631                 }
1632             }
1633             merged
1634         }
1635     }
1636 }
1637
1638 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for ExplicitOutlivesRequirements {
1639     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx hir::Item<'_>) {
1640         use rustc_middle::middle::resolve_lifetime::Region;
1641
1642         let infer_static = cx.tcx.features().infer_static_outlives_requirements;
1643         let def_id = cx.tcx.hir().local_def_id(item.hir_id);
1644         if let hir::ItemKind::Struct(_, ref hir_generics)
1645         | hir::ItemKind::Enum(_, ref hir_generics)
1646         | hir::ItemKind::Union(_, ref hir_generics) = item.kind
1647         {
1648             let inferred_outlives = cx.tcx.inferred_outlives_of(def_id);
1649             if inferred_outlives.is_empty() {
1650                 return;
1651             }
1652
1653             let ty_generics = cx.tcx.generics_of(def_id);
1654
1655             let mut bound_count = 0;
1656             let mut lint_spans = Vec::new();
1657
1658             for param in hir_generics.params {
1659                 let has_lifetime_bounds = param.bounds.iter().any(|bound| {
1660                     if let hir::GenericBound::Outlives(_) = bound { true } else { false }
1661                 });
1662                 if !has_lifetime_bounds {
1663                     continue;
1664                 }
1665
1666                 let relevant_lifetimes =
1667                     self.collect_outlived_lifetimes(param, cx.tcx, inferred_outlives, ty_generics);
1668                 if relevant_lifetimes.is_empty() {
1669                     continue;
1670                 }
1671
1672                 let bound_spans = self.collect_outlives_bound_spans(
1673                     cx.tcx,
1674                     &param.bounds,
1675                     &relevant_lifetimes,
1676                     infer_static,
1677                 );
1678                 bound_count += bound_spans.len();
1679                 lint_spans.extend(self.consolidate_outlives_bound_spans(
1680                     param.span.shrink_to_hi(),
1681                     &param.bounds,
1682                     bound_spans,
1683                 ));
1684             }
1685
1686             let mut where_lint_spans = Vec::new();
1687             let mut dropped_predicate_count = 0;
1688             let num_predicates = hir_generics.where_clause.predicates.len();
1689             for (i, where_predicate) in hir_generics.where_clause.predicates.iter().enumerate() {
1690                 let (relevant_lifetimes, bounds, span) = match where_predicate {
1691                     hir::WherePredicate::RegionPredicate(predicate) => {
1692                         if let Some(Region::EarlyBound(index, ..)) =
1693                             cx.tcx.named_region(predicate.lifetime.hir_id)
1694                         {
1695                             (
1696                                 Self::lifetimes_outliving_lifetime(inferred_outlives, index),
1697                                 &predicate.bounds,
1698                                 predicate.span,
1699                             )
1700                         } else {
1701                             continue;
1702                         }
1703                     }
1704                     hir::WherePredicate::BoundPredicate(predicate) => {
1705                         // FIXME we can also infer bounds on associated types,
1706                         // and should check for them here.
1707                         match predicate.bounded_ty.kind {
1708                             hir::TyKind::Path(hir::QPath::Resolved(None, ref path)) => {
1709                                 if let Res::Def(DefKind::TyParam, def_id) = path.res {
1710                                     let index = ty_generics.param_def_id_to_index[&def_id];
1711                                     (
1712                                         Self::lifetimes_outliving_type(inferred_outlives, index),
1713                                         &predicate.bounds,
1714                                         predicate.span,
1715                                     )
1716                                 } else {
1717                                     continue;
1718                                 }
1719                             }
1720                             _ => {
1721                                 continue;
1722                             }
1723                         }
1724                     }
1725                     _ => continue,
1726                 };
1727                 if relevant_lifetimes.is_empty() {
1728                     continue;
1729                 }
1730
1731                 let bound_spans = self.collect_outlives_bound_spans(
1732                     cx.tcx,
1733                     bounds,
1734                     &relevant_lifetimes,
1735                     infer_static,
1736                 );
1737                 bound_count += bound_spans.len();
1738
1739                 let drop_predicate = bound_spans.len() == bounds.len();
1740                 if drop_predicate {
1741                     dropped_predicate_count += 1;
1742                 }
1743
1744                 // If all the bounds on a predicate were inferable and there are
1745                 // further predicates, we want to eat the trailing comma.
1746                 if drop_predicate && i + 1 < num_predicates {
1747                     let next_predicate_span = hir_generics.where_clause.predicates[i + 1].span();
1748                     where_lint_spans.push(span.to(next_predicate_span.shrink_to_lo()));
1749                 } else {
1750                     where_lint_spans.extend(self.consolidate_outlives_bound_spans(
1751                         span.shrink_to_lo(),
1752                         bounds,
1753                         bound_spans,
1754                     ));
1755                 }
1756             }
1757
1758             // If all predicates are inferable, drop the entire clause
1759             // (including the `where`)
1760             if num_predicates > 0 && dropped_predicate_count == num_predicates {
1761                 let where_span = hir_generics
1762                     .where_clause
1763                     .span()
1764                     .expect("span of (nonempty) where clause should exist");
1765                 // Extend the where clause back to the closing `>` of the
1766                 // generics, except for tuple struct, which have the `where`
1767                 // after the fields of the struct.
1768                 let full_where_span =
1769                     if let hir::ItemKind::Struct(hir::VariantData::Tuple(..), _) = item.kind {
1770                         where_span
1771                     } else {
1772                         hir_generics.span.shrink_to_hi().to(where_span)
1773                     };
1774                 lint_spans.push(full_where_span);
1775             } else {
1776                 lint_spans.extend(where_lint_spans);
1777             }
1778
1779             if !lint_spans.is_empty() {
1780                 cx.struct_span_lint(EXPLICIT_OUTLIVES_REQUIREMENTS, lint_spans.clone(), |lint| {
1781                     lint.build("outlives requirements can be inferred")
1782                         .multipart_suggestion(
1783                             if bound_count == 1 {
1784                                 "remove this bound"
1785                             } else {
1786                                 "remove these bounds"
1787                             },
1788                             lint_spans
1789                                 .into_iter()
1790                                 .map(|span| (span, "".to_owned()))
1791                                 .collect::<Vec<_>>(),
1792                             Applicability::MachineApplicable,
1793                         )
1794                         .emit();
1795                 });
1796             }
1797         }
1798     }
1799 }
1800
1801 declare_lint! {
1802     pub INCOMPLETE_FEATURES,
1803     Warn,
1804     "incomplete features that may function improperly in some or all cases"
1805 }
1806
1807 declare_lint_pass!(
1808     /// Check for used feature gates in `INCOMPLETE_FEATURES` in `librustc_feature/active.rs`.
1809     IncompleteFeatures => [INCOMPLETE_FEATURES]
1810 );
1811
1812 impl EarlyLintPass for IncompleteFeatures {
1813     fn check_crate(&mut self, cx: &EarlyContext<'_>, _: &ast::Crate) {
1814         let features = cx.sess.features_untracked();
1815         features
1816             .declared_lang_features
1817             .iter()
1818             .map(|(name, span, _)| (name, span))
1819             .chain(features.declared_lib_features.iter().map(|(name, span)| (name, span)))
1820             .filter(|(name, _)| rustc_feature::INCOMPLETE_FEATURES.iter().any(|f| name == &f))
1821             .for_each(|(&name, &span)| {
1822                 cx.struct_span_lint(INCOMPLETE_FEATURES, span, |lint| {
1823                     let mut builder = lint.build(&format!(
1824                         "the feature `{}` is incomplete and may not be safe to use \
1825                          and/or cause compiler crashes",
1826                         name,
1827                     ));
1828                     if let Some(n) = rustc_feature::find_feature_issue(name, GateIssue::Language) {
1829                         builder.note(&format!(
1830                             "see issue #{} <https://github.com/rust-lang/rust/issues/{}> \
1831                              for more information",
1832                             n, n,
1833                         ));
1834                     }
1835                     builder.emit();
1836                 })
1837             });
1838     }
1839 }
1840
1841 declare_lint! {
1842     pub INVALID_VALUE,
1843     Warn,
1844     "an invalid value is being created (such as a NULL reference)"
1845 }
1846
1847 declare_lint_pass!(InvalidValue => [INVALID_VALUE]);
1848
1849 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for InvalidValue {
1850     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &hir::Expr<'_>) {
1851         #[derive(Debug, Copy, Clone, PartialEq)]
1852         enum InitKind {
1853             Zeroed,
1854             Uninit,
1855         };
1856
1857         /// Information about why a type cannot be initialized this way.
1858         /// Contains an error message and optionally a span to point at.
1859         type InitError = (String, Option<Span>);
1860
1861         /// Test if this constant is all-0.
1862         fn is_zero(expr: &hir::Expr<'_>) -> bool {
1863             use hir::ExprKind::*;
1864             use rustc_ast::ast::LitKind::*;
1865             match &expr.kind {
1866                 Lit(lit) => {
1867                     if let Int(i, _) = lit.node {
1868                         i == 0
1869                     } else {
1870                         false
1871                     }
1872                 }
1873                 Tup(tup) => tup.iter().all(is_zero),
1874                 _ => false,
1875             }
1876         }
1877
1878         /// Determine if this expression is a "dangerous initialization".
1879         fn is_dangerous_init(cx: &LateContext<'_, '_>, expr: &hir::Expr<'_>) -> Option<InitKind> {
1880             // `transmute` is inside an anonymous module (the `extern` block?);
1881             // `Invalid` represents the empty string and matches that.
1882             // FIXME(#66075): use diagnostic items.  Somehow, that does not seem to work
1883             // on intrinsics right now.
1884             const TRANSMUTE_PATH: &[Symbol] =
1885                 &[sym::core, sym::intrinsics, kw::Invalid, sym::transmute];
1886
1887             if let hir::ExprKind::Call(ref path_expr, ref args) = expr.kind {
1888                 // Find calls to `mem::{uninitialized,zeroed}` methods.
1889                 if let hir::ExprKind::Path(ref qpath) = path_expr.kind {
1890                     let def_id = cx.tables.qpath_res(qpath, path_expr.hir_id).opt_def_id()?;
1891
1892                     if cx.tcx.is_diagnostic_item(sym::mem_zeroed, def_id) {
1893                         return Some(InitKind::Zeroed);
1894                     } else if cx.tcx.is_diagnostic_item(sym::mem_uninitialized, def_id) {
1895                         return Some(InitKind::Uninit);
1896                     } else if cx.match_def_path(def_id, TRANSMUTE_PATH) {
1897                         if is_zero(&args[0]) {
1898                             return Some(InitKind::Zeroed);
1899                         }
1900                     }
1901                 }
1902             } else if let hir::ExprKind::MethodCall(_, _, ref args) = expr.kind {
1903                 // Find problematic calls to `MaybeUninit::assume_init`.
1904                 let def_id = cx.tables.type_dependent_def_id(expr.hir_id)?;
1905                 if cx.tcx.is_diagnostic_item(sym::assume_init, def_id) {
1906                     // This is a call to *some* method named `assume_init`.
1907                     // See if the `self` parameter is one of the dangerous constructors.
1908                     if let hir::ExprKind::Call(ref path_expr, _) = args[0].kind {
1909                         if let hir::ExprKind::Path(ref qpath) = path_expr.kind {
1910                             let def_id =
1911                                 cx.tables.qpath_res(qpath, path_expr.hir_id).opt_def_id()?;
1912
1913                             if cx.tcx.is_diagnostic_item(sym::maybe_uninit_zeroed, def_id) {
1914                                 return Some(InitKind::Zeroed);
1915                             } else if cx.tcx.is_diagnostic_item(sym::maybe_uninit_uninit, def_id) {
1916                                 return Some(InitKind::Uninit);
1917                             }
1918                         }
1919                     }
1920                 }
1921             }
1922
1923             None
1924         }
1925
1926         /// Return `Some` only if we are sure this type does *not*
1927         /// allow zero initialization.
1928         fn ty_find_init_error<'tcx>(
1929             tcx: TyCtxt<'tcx>,
1930             ty: Ty<'tcx>,
1931             init: InitKind,
1932         ) -> Option<InitError> {
1933             use rustc_middle::ty::TyKind::*;
1934             match ty.kind {
1935                 // Primitive types that don't like 0 as a value.
1936                 Ref(..) => Some(("references must be non-null".to_string(), None)),
1937                 Adt(..) if ty.is_box() => Some(("`Box` must be non-null".to_string(), None)),
1938                 FnPtr(..) => Some(("function pointers must be non-null".to_string(), None)),
1939                 Never => Some(("the `!` type has no valid value".to_string(), None)),
1940                 RawPtr(tm) if matches!(tm.ty.kind, Dynamic(..)) =>
1941                 // raw ptr to dyn Trait
1942                 {
1943                     Some(("the vtable of a wide raw pointer must be non-null".to_string(), None))
1944                 }
1945                 // Primitive types with other constraints.
1946                 Bool if init == InitKind::Uninit => {
1947                     Some(("booleans must be either `true` or `false`".to_string(), None))
1948                 }
1949                 Char if init == InitKind::Uninit => {
1950                     Some(("characters must be a valid Unicode codepoint".to_string(), None))
1951                 }
1952                 // Recurse and checks for some compound types.
1953                 Adt(adt_def, substs) if !adt_def.is_union() => {
1954                     // First check f this ADT has a layout attribute (like `NonNull` and friends).
1955                     use std::ops::Bound;
1956                     match tcx.layout_scalar_valid_range(adt_def.did) {
1957                         // We exploit here that `layout_scalar_valid_range` will never
1958                         // return `Bound::Excluded`.  (And we have tests checking that we
1959                         // handle the attribute correctly.)
1960                         (Bound::Included(lo), _) if lo > 0 => {
1961                             return Some((format!("`{}` must be non-null", ty), None));
1962                         }
1963                         (Bound::Included(_), _) | (_, Bound::Included(_))
1964                             if init == InitKind::Uninit =>
1965                         {
1966                             return Some((
1967                                 format!(
1968                                     "`{}` must be initialized inside its custom valid range",
1969                                     ty,
1970                                 ),
1971                                 None,
1972                             ));
1973                         }
1974                         _ => {}
1975                     }
1976                     // Now, recurse.
1977                     match adt_def.variants.len() {
1978                         0 => Some(("enums with no variants have no valid value".to_string(), None)),
1979                         1 => {
1980                             // Struct, or enum with exactly one variant.
1981                             // Proceed recursively, check all fields.
1982                             let variant = &adt_def.variants[VariantIdx::from_u32(0)];
1983                             variant.fields.iter().find_map(|field| {
1984                                 ty_find_init_error(tcx, field.ty(tcx, substs), init).map(
1985                                     |(mut msg, span)| {
1986                                         if span.is_none() {
1987                                             // Point to this field, should be helpful for figuring
1988                                             // out where the source of the error is.
1989                                             let span = tcx.def_span(field.did);
1990                                             write!(
1991                                                 &mut msg,
1992                                                 " (in this {} field)",
1993                                                 adt_def.descr()
1994                                             )
1995                                             .unwrap();
1996                                             (msg, Some(span))
1997                                         } else {
1998                                             // Just forward.
1999                                             (msg, span)
2000                                         }
2001                                     },
2002                                 )
2003                             })
2004                         }
2005                         // Multi-variant enums are tricky: if all but one variant are
2006                         // uninhabited, we might actually do layout like for a single-variant
2007                         // enum, and then even leaving them uninitialized could be okay.
2008                         _ => None, // Conservative fallback for multi-variant enum.
2009                     }
2010                 }
2011                 Tuple(..) => {
2012                     // Proceed recursively, check all fields.
2013                     ty.tuple_fields().find_map(|field| ty_find_init_error(tcx, field, init))
2014                 }
2015                 // Conservative fallback.
2016                 _ => None,
2017             }
2018         }
2019
2020         if let Some(init) = is_dangerous_init(cx, expr) {
2021             // This conjures an instance of a type out of nothing,
2022             // using zeroed or uninitialized memory.
2023             // We are extremely conservative with what we warn about.
2024             let conjured_ty = cx.tables.expr_ty(expr);
2025             if let Some((msg, span)) = ty_find_init_error(cx.tcx, conjured_ty, init) {
2026                 cx.struct_span_lint(INVALID_VALUE, expr.span, |lint| {
2027                     let mut err = lint.build(&format!(
2028                         "the type `{}` does not permit {}",
2029                         conjured_ty,
2030                         match init {
2031                             InitKind::Zeroed => "zero-initialization",
2032                             InitKind::Uninit => "being left uninitialized",
2033                         },
2034                     ));
2035                     err.span_label(expr.span, "this code causes undefined behavior when executed");
2036                     err.span_label(
2037                         expr.span,
2038                         "help: use `MaybeUninit<T>` instead, \
2039                             and only call `assume_init` after initialization is done",
2040                     );
2041                     if let Some(span) = span {
2042                         err.span_note(span, &msg);
2043                     } else {
2044                         err.note(&msg);
2045                     }
2046                     err.emit();
2047                 });
2048             }
2049         }
2050     }
2051 }