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