//! Implementation of lint checking. //! //! The lint checking is mostly consolidated into one pass which runs //! after all other analyses. Throughout compilation, lint warnings //! can be added via the `add_lint` method on the Session structure. This //! requires a span and an ID of the node that the lint is being added to. The //! lint isn't actually emitted at that time because it is unknown what the //! actual lint level at that location is. //! //! To actually emit lint warnings/errors, a separate pass is used. //! A context keeps track of the current state of all lint levels. //! Upon entering a node of the ast which can modify the lint settings, the //! previous lint state is pushed onto a stack and the ast is then recursed //! upon. As the ast is traversed, this keeps track of the current lint level //! for all lint attributes. use self::TargetLint::*; use crate::hir; use crate::hir::def_id::{CrateNum, DefId, LOCAL_CRATE}; use crate::hir::intravisit as hir_visit; use crate::hir::intravisit::Visitor; use crate::hir::map::{definitions::DisambiguatedDefPathData, DefPathData}; use crate::lint::{EarlyLintPass, LateLintPass, EarlyLintPassObject, LateLintPassObject}; use crate::lint::{Level, Lint, LintId, LintPass, LintBuffer, FutureIncompatibleInfo}; use crate::lint::builtin::BuiltinLintDiagnostics; use crate::lint::levels::{LintLevelSets, LintLevelsBuilder}; use crate::middle::privacy::AccessLevels; use crate::session::Session; use crate::ty::{self, print::Printer, subst::GenericArg, TyCtxt, Ty}; use crate::ty::layout::{LayoutError, LayoutOf, TyLayout}; use crate::util::nodemap::FxHashMap; use crate::util::common::time; use errors::DiagnosticBuilder; use std::slice; use rustc_data_structures::sync::{self, ParallelIterator, join, par_iter}; use syntax::ast; use syntax::util::lev_distance::find_best_match_for_name; use syntax::visit as ast_visit; use syntax_pos::{MultiSpan, Span, symbol::Symbol}; use rustc_error_codes::*; /// Information about the registered lints. /// /// This is basically the subset of `Context` that we can /// build early in the compile pipeline. pub struct LintStore { /// Registered lints. lints: Vec<&'static Lint>, /// Constructor functions for each variety of lint pass. /// /// These should only be called once, but since we want to avoid locks or /// interior mutability, we don't enforce this (and lints should, in theory, /// be compatible with being constructed more than once, though not /// necessarily in a sane manner. This is safe though.) pre_expansion_passes: Vec EarlyLintPassObject + sync::Send + sync::Sync>>, early_passes: Vec EarlyLintPassObject + sync::Send + sync::Sync>>, late_passes: Vec LateLintPassObject + sync::Send + sync::Sync>>, /// This is unique in that we construct them per-module, so not once. late_module_passes: Vec LateLintPassObject + sync::Send + sync::Sync>>, /// Lints indexed by name. by_name: FxHashMap, /// Map of registered lint groups to what lints they expand to. lint_groups: FxHashMap<&'static str, LintGroup>, } /// Lints that are buffered up early on in the `Session` before the /// `LintLevels` is calculated #[derive(PartialEq, Debug)] pub struct BufferedEarlyLint { pub lint_id: LintId, pub ast_id: ast::NodeId, pub span: MultiSpan, pub msg: String, pub diagnostic: BuiltinLintDiagnostics, } /// The target of the `by_name` map, which accounts for renaming/deprecation. enum TargetLint { /// A direct lint target Id(LintId), /// Temporary renaming, used for easing migration pain; see #16545 Renamed(String, LintId), /// Lint with this name existed previously, but has been removed/deprecated. /// The string argument is the reason for removal. Removed(String), } pub enum FindLintError { NotFound, Removed, } struct LintAlias { name: &'static str, /// Whether deprecation warnings should be suppressed for this alias. silent: bool, } struct LintGroup { lint_ids: Vec, from_plugin: bool, depr: Option, } pub enum CheckLintNameResult<'a> { Ok(&'a [LintId]), /// Lint doesn't exist. Potentially contains a suggestion for a correct lint name. NoLint(Option), /// The lint is either renamed or removed. This is the warning /// message, and an optional new name (`None` if removed). Warning(String, Option), /// The lint is from a tool. If the Option is None, then either /// the lint does not exist in the tool or the code was not /// compiled with the tool and therefore the lint was never /// added to the `LintStore`. Otherwise the `LintId` will be /// returned as if it where a rustc lint. Tool(Result<&'a [LintId], (Option<&'a [LintId]>, String)>), } impl LintStore { pub fn new() -> LintStore { LintStore { lints: vec![], pre_expansion_passes: vec![], early_passes: vec![], late_passes: vec![], late_module_passes: vec![], by_name: Default::default(), lint_groups: Default::default(), } } pub fn get_lints<'t>(&'t self) -> &'t [&'static Lint] { &self.lints } pub fn get_lint_groups<'t>(&'t self) -> Vec<(&'static str, Vec, bool)> { self.lint_groups.iter() .filter(|(_, LintGroup { depr, .. })| { // Don't display deprecated lint groups. depr.is_none() }) .map(|(k, LintGroup { lint_ids, from_plugin, .. })| { (*k, lint_ids.clone(), *from_plugin) }) .collect() } pub fn register_early_pass( &mut self, pass: impl Fn() -> EarlyLintPassObject + 'static + sync::Send + sync::Sync ) { self.early_passes.push(Box::new(pass)); } pub fn register_pre_expansion_pass( &mut self, pass: impl Fn() -> EarlyLintPassObject + 'static + sync::Send + sync::Sync, ) { self.pre_expansion_passes.push(Box::new(pass)); } pub fn register_late_pass( &mut self, pass: impl Fn() -> LateLintPassObject + 'static + sync::Send + sync::Sync, ) { self.late_passes.push(Box::new(pass)); } pub fn register_late_mod_pass( &mut self, pass: impl Fn() -> LateLintPassObject + 'static + sync::Send + sync::Sync, ) { self.late_module_passes.push(Box::new(pass)); } // Helper method for register_early/late_pass pub fn register_lints(&mut self, lints: &[&'static Lint]) { for lint in lints { self.lints.push(lint); let id = LintId::of(lint); if self.by_name.insert(lint.name_lower(), Id(id)).is_some() { bug!("duplicate specification of lint {}", lint.name_lower()) } if let Some(FutureIncompatibleInfo { edition, .. }) = lint.future_incompatible { if let Some(edition) = edition { self.lint_groups.entry(edition.lint_name()) .or_insert(LintGroup { lint_ids: vec![], from_plugin: lint.is_plugin, depr: None, }) .lint_ids.push(id); } self.lint_groups.entry("future_incompatible") .or_insert(LintGroup { lint_ids: vec![], from_plugin: lint.is_plugin, depr: None, }) .lint_ids.push(id); } } } pub fn register_group_alias( &mut self, lint_name: &'static str, alias: &'static str, ) { self.lint_groups.insert(alias, LintGroup { lint_ids: vec![], from_plugin: false, depr: Some(LintAlias { name: lint_name, silent: true }), }); } pub fn register_group( &mut self, from_plugin: bool, name: &'static str, deprecated_name: Option<&'static str>, to: Vec, ) { let new = self .lint_groups .insert(name, LintGroup { lint_ids: to, from_plugin, depr: None, }) .is_none(); if let Some(deprecated) = deprecated_name { self.lint_groups.insert(deprecated, LintGroup { lint_ids: vec![], from_plugin, depr: Some(LintAlias { name, silent: false }), }); } if !new { bug!("duplicate specification of lint group {}", name); } } pub fn register_renamed(&mut self, old_name: &str, new_name: &str) { let target = match self.by_name.get(new_name) { Some(&Id(lint_id)) => lint_id.clone(), _ => bug!("invalid lint renaming of {} to {}", old_name, new_name) }; self.by_name.insert(old_name.to_string(), Renamed(new_name.to_string(), target)); } pub fn register_removed(&mut self, name: &str, reason: &str) { self.by_name.insert(name.into(), Removed(reason.into())); } pub fn find_lints(&self, mut lint_name: &str) -> Result, FindLintError> { match self.by_name.get(lint_name) { Some(&Id(lint_id)) => Ok(vec![lint_id]), Some(&Renamed(_, lint_id)) => { Ok(vec![lint_id]) }, Some(&Removed(_)) => { Err(FindLintError::Removed) }, None => { loop { return match self.lint_groups.get(lint_name) { Some(LintGroup {lint_ids, depr, .. }) => { if let Some(LintAlias { name, .. }) = depr { lint_name = name; continue; } Ok(lint_ids.clone()) } None => Err(FindLintError::Removed) }; } } } } /// Checks the validity of lint names derived from the command line pub fn check_lint_name_cmdline(&self, sess: &Session, lint_name: &str, level: Level) { let db = match self.check_lint_name(lint_name, None) { CheckLintNameResult::Ok(_) => None, CheckLintNameResult::Warning(ref msg, _) => { Some(sess.struct_warn(msg)) }, CheckLintNameResult::NoLint(suggestion) => { let mut err = struct_err!(sess, E0602, "unknown lint: `{}`", lint_name); if let Some(suggestion) = suggestion { err.help(&format!("did you mean: `{}`", suggestion)); } Some(err) } CheckLintNameResult::Tool(result) => match result { Err((Some(_), new_name)) => Some(sess.struct_warn(&format!( "lint name `{}` is deprecated \ and does not have an effect anymore. \ Use: {}", lint_name, new_name ))), _ => None, }, }; if let Some(mut db) = db { let msg = format!("requested on the command line with `{} {}`", match level { Level::Allow => "-A", Level::Warn => "-W", Level::Deny => "-D", Level::Forbid => "-F", }, lint_name); db.note(&msg); db.emit(); } } /// Checks the name of a lint for its existence, and whether it was /// renamed or removed. Generates a DiagnosticBuilder containing a /// warning for renamed and removed lints. This is over both lint /// names from attributes and those passed on the command line. Since /// it emits non-fatal warnings and there are *two* lint passes that /// inspect attributes, this is only run from the late pass to avoid /// printing duplicate warnings. pub fn check_lint_name( &self, lint_name: &str, tool_name: Option, ) -> CheckLintNameResult<'_> { let complete_name = if let Some(tool_name) = tool_name { format!("{}::{}", tool_name, lint_name) } else { lint_name.to_string() }; // If the lint was scoped with `tool::` check if the tool lint exists if let Some(_) = tool_name { match self.by_name.get(&complete_name) { None => match self.lint_groups.get(&*complete_name) { None => return CheckLintNameResult::Tool(Err((None, String::new()))), Some(LintGroup { lint_ids, .. }) => { return CheckLintNameResult::Tool(Ok(&lint_ids)); } }, Some(&Id(ref id)) => return CheckLintNameResult::Tool(Ok(slice::from_ref(id))), // If the lint was registered as removed or renamed by the lint tool, we don't need // to treat tool_lints and rustc lints different and can use the code below. _ => {} } } match self.by_name.get(&complete_name) { Some(&Renamed(ref new_name, _)) => CheckLintNameResult::Warning( format!( "lint `{}` has been renamed to `{}`", complete_name, new_name ), Some(new_name.to_owned()), ), Some(&Removed(ref reason)) => CheckLintNameResult::Warning( format!("lint `{}` has been removed: `{}`", complete_name, reason), None, ), None => match self.lint_groups.get(&*complete_name) { // If neither the lint, nor the lint group exists check if there is a `clippy::` // variant of this lint None => self.check_tool_name_for_backwards_compat(&complete_name, "clippy"), Some(LintGroup { lint_ids, depr, .. }) => { // Check if the lint group name is deprecated if let Some(LintAlias { name, silent }) = depr { let LintGroup { lint_ids, .. } = self.lint_groups.get(name).unwrap(); return if *silent { CheckLintNameResult::Ok(&lint_ids) } else { CheckLintNameResult::Tool(Err(( Some(&lint_ids), name.to_string(), ))) }; } CheckLintNameResult::Ok(&lint_ids) } }, Some(&Id(ref id)) => CheckLintNameResult::Ok(slice::from_ref(id)), } } fn check_tool_name_for_backwards_compat( &self, lint_name: &str, tool_name: &str, ) -> CheckLintNameResult<'_> { let complete_name = format!("{}::{}", tool_name, lint_name); match self.by_name.get(&complete_name) { None => match self.lint_groups.get(&*complete_name) { // Now we are sure, that this lint exists nowhere None => { let symbols = self.by_name.keys() .map(|name| Symbol::intern(&name)) .collect::>(); let suggestion = find_best_match_for_name(symbols.iter(), &lint_name.to_lowercase(), None); CheckLintNameResult::NoLint(suggestion) } Some(LintGroup { lint_ids, depr, .. }) => { // Reaching this would be weird, but let's cover this case anyway if let Some(LintAlias { name, silent }) = depr { let LintGroup { lint_ids, .. } = self.lint_groups.get(name).unwrap(); return if *silent { CheckLintNameResult::Tool(Err((Some(&lint_ids), complete_name))) } else { CheckLintNameResult::Tool(Err(( Some(&lint_ids), name.to_string(), ))) }; } CheckLintNameResult::Tool(Err((Some(&lint_ids), complete_name))) } }, Some(&Id(ref id)) => { CheckLintNameResult::Tool(Err((Some(slice::from_ref(id)), complete_name))) } _ => CheckLintNameResult::NoLint(None), } } } /// Context for lint checking after type checking. pub struct LateContext<'a, 'tcx> { /// Type context we're checking in. pub tcx: TyCtxt<'tcx>, /// Side-tables for the body we are in. // FIXME: Make this lazy to avoid running the TypeckTables query? pub tables: &'a ty::TypeckTables<'tcx>, /// Parameter environment for the item we are in. pub param_env: ty::ParamEnv<'tcx>, /// Items accessible from the crate being checked. pub access_levels: &'a AccessLevels, /// The store of registered lints and the lint levels. lint_store: &'tcx LintStore, last_node_with_lint_attrs: hir::HirId, /// Generic type parameters in scope for the item we are in. pub generics: Option<&'tcx hir::Generics>, /// We are only looking at one module only_module: bool, } pub struct LateContextAndPass<'a, 'tcx, T: LateLintPass<'a, 'tcx>> { context: LateContext<'a, 'tcx>, pass: T, } /// Context for lint checking of the AST, after expansion, before lowering to /// HIR. pub struct EarlyContext<'a> { /// Type context we're checking in. pub sess: &'a Session, /// The crate being checked. pub krate: &'a ast::Crate, builder: LintLevelsBuilder<'a>, /// The store of registered lints and the lint levels. lint_store: &'a LintStore, buffered: LintBuffer, } pub struct EarlyContextAndPass<'a, T: EarlyLintPass> { context: EarlyContext<'a>, pass: T, } pub trait LintPassObject: Sized {} impl LintPassObject for EarlyLintPassObject {} impl LintPassObject for LateLintPassObject {} pub trait LintContext: Sized { type PassObject: LintPassObject; fn sess(&self) -> &Session; fn lints(&self) -> &LintStore; fn lookup_and_emit>(&self, lint: &'static Lint, span: Option, msg: &str) { self.lookup(lint, span, msg).emit(); } fn lookup_and_emit_with_diagnostics>(&self, lint: &'static Lint, span: Option, msg: &str, diagnostic: BuiltinLintDiagnostics) { let mut db = self.lookup(lint, span, msg); diagnostic.run(self.sess(), &mut db); db.emit(); } fn lookup>(&self, lint: &'static Lint, span: Option, msg: &str) -> DiagnosticBuilder<'_>; /// Emit a lint at the appropriate level, for a particular span. fn span_lint>(&self, lint: &'static Lint, span: S, msg: &str) { self.lookup_and_emit(lint, Some(span), msg); } fn struct_span_lint>(&self, lint: &'static Lint, span: S, msg: &str) -> DiagnosticBuilder<'_> { self.lookup(lint, Some(span), msg) } /// Emit a lint and note at the appropriate level, for a particular span. fn span_lint_note(&self, lint: &'static Lint, span: Span, msg: &str, note_span: Span, note: &str) { let mut err = self.lookup(lint, Some(span), msg); if note_span == span { err.note(note); } else { err.span_note(note_span, note); } err.emit(); } /// Emit a lint and help at the appropriate level, for a particular span. fn span_lint_help(&self, lint: &'static Lint, span: Span, msg: &str, help: &str) { let mut err = self.lookup(lint, Some(span), msg); self.span_lint(lint, span, msg); err.span_help(span, help); err.emit(); } /// Emit a lint at the appropriate level, with no associated span. fn lint(&self, lint: &'static Lint, msg: &str) { self.lookup_and_emit(lint, None as Option, msg); } } impl<'a> EarlyContext<'a> { fn new( sess: &'a Session, lint_store: &'a LintStore, krate: &'a ast::Crate, buffered: LintBuffer, warn_about_weird_lints: bool, ) -> EarlyContext<'a> { EarlyContext { sess, krate, lint_store, builder: LintLevelSets::builder(sess, warn_about_weird_lints, lint_store), buffered, } } } macro_rules! lint_callback { ($cx:expr, $f:ident, $($args:expr),*) => ({ $cx.pass.$f(&$cx.context, $($args),*); }) } macro_rules! run_early_pass { ($cx:expr, $f:ident, $($args:expr),*) => ({ $cx.pass.$f(&$cx.context, $($args),*); }) } impl<'a, T: EarlyLintPass> EarlyContextAndPass<'a, T> { fn check_id(&mut self, id: ast::NodeId) { for early_lint in self.context.buffered.take(id) { self.context.lookup_and_emit_with_diagnostics( early_lint.lint_id.lint, Some(early_lint.span.clone()), &early_lint.msg, early_lint.diagnostic ); } } /// Merge the lints specified by any lint attributes into the /// current lint context, call the provided function, then reset the /// lints in effect to their previous state. fn with_lint_attrs(&mut self, id: ast::NodeId, attrs: &'a [ast::Attribute], f: F) where F: FnOnce(&mut Self) { let push = self.context.builder.push(attrs, &self.context.lint_store); self.check_id(id); self.enter_attrs(attrs); f(self); self.exit_attrs(attrs); self.context.builder.pop(push); } fn enter_attrs(&mut self, attrs: &'a [ast::Attribute]) { debug!("early context: enter_attrs({:?})", attrs); run_early_pass!(self, enter_lint_attrs, attrs); } fn exit_attrs(&mut self, attrs: &'a [ast::Attribute]) { debug!("early context: exit_attrs({:?})", attrs); run_early_pass!(self, exit_lint_attrs, attrs); } } impl LintContext for LateContext<'_, '_> { type PassObject = LateLintPassObject; /// Gets the overall compiler `Session` object. fn sess(&self) -> &Session { &self.tcx.sess } fn lints(&self) -> &LintStore { &*self.lint_store } fn lookup>(&self, lint: &'static Lint, span: Option, msg: &str) -> DiagnosticBuilder<'_> { let hir_id = self.last_node_with_lint_attrs; match span { Some(s) => self.tcx.struct_span_lint_hir(lint, hir_id, s, msg), None => { self.tcx.struct_lint_node(lint, hir_id, msg) }, } } } impl LintContext for EarlyContext<'_> { type PassObject = EarlyLintPassObject; /// Gets the overall compiler `Session` object. fn sess(&self) -> &Session { &self.sess } fn lints(&self) -> &LintStore { &*self.lint_store } fn lookup>(&self, lint: &'static Lint, span: Option, msg: &str) -> DiagnosticBuilder<'_> { self.builder.struct_lint(lint, span.map(|s| s.into()), msg) } } impl<'a, 'tcx> LateContext<'a, 'tcx> { pub fn current_lint_root(&self) -> hir::HirId { self.last_node_with_lint_attrs } /// Check if a `DefId`'s path matches the given absolute type path usage. /// /// Anonymous scopes such as `extern` imports are matched with `kw::Invalid`; /// inherent `impl` blocks are matched with the name of the type. /// /// # Examples /// /// ```rust,ignore (no context or def id available) /// if cx.match_def_path(def_id, &[sym::core, sym::option, sym::Option]) { /// // The given `def_id` is that of an `Option` type /// } /// ``` pub fn match_def_path(&self, def_id: DefId, path: &[Symbol]) -> bool { let names = self.get_def_path(def_id); names.len() == path.len() && names.into_iter().zip(path.iter()).all(|(a, &b)| a == b) } /// Gets the absolute path of `def_id` as a vector of `Symbol`. /// /// # Examples /// /// ```rust,ignore (no context or def id available) /// let def_path = cx.get_def_path(def_id); /// if let &[sym::core, sym::option, sym::Option] = &def_path[..] { /// // The given `def_id` is that of an `Option` type /// } /// ``` pub fn get_def_path(&self, def_id: DefId) -> Vec { pub struct AbsolutePathPrinter<'tcx> { pub tcx: TyCtxt<'tcx>, } impl<'tcx> Printer<'tcx> for AbsolutePathPrinter<'tcx> { type Error = !; type Path = Vec; type Region = (); type Type = (); type DynExistential = (); type Const = (); fn tcx(&self) -> TyCtxt<'tcx> { self.tcx } fn print_region(self, _region: ty::Region<'_>) -> Result { Ok(()) } fn print_type(self, _ty: Ty<'tcx>) -> Result { Ok(()) } fn print_dyn_existential( self, _predicates: &'tcx ty::List>, ) -> Result { Ok(()) } fn print_const( self, _ct: &'tcx ty::Const<'tcx>, ) -> Result { Ok(()) } fn path_crate(self, cnum: CrateNum) -> Result { Ok(vec![self.tcx.original_crate_name(cnum)]) } fn path_qualified( self, self_ty: Ty<'tcx>, trait_ref: Option>, ) -> Result { if trait_ref.is_none() { if let ty::Adt(def, substs) = self_ty.kind { return self.print_def_path(def.did, substs); } } // This shouldn't ever be needed, but just in case: Ok(vec![match trait_ref { Some(trait_ref) => Symbol::intern(&format!("{:?}", trait_ref)), None => Symbol::intern(&format!("<{}>", self_ty)), }]) } fn path_append_impl( self, print_prefix: impl FnOnce(Self) -> Result, _disambiguated_data: &DisambiguatedDefPathData, self_ty: Ty<'tcx>, trait_ref: Option>, ) -> Result { let mut path = print_prefix(self)?; // This shouldn't ever be needed, but just in case: path.push(match trait_ref { Some(trait_ref) => { Symbol::intern( &format!( "", trait_ref.print_only_trait_path(), self_ty ) ) }, None => Symbol::intern(&format!("", self_ty)), }); Ok(path) } fn path_append( self, print_prefix: impl FnOnce(Self) -> Result, disambiguated_data: &DisambiguatedDefPathData, ) -> Result { let mut path = print_prefix(self)?; // Skip `::{{constructor}}` on tuple/unit structs. match disambiguated_data.data { DefPathData::Ctor => return Ok(path), _ => {} } path.push(disambiguated_data.data.as_symbol()); Ok(path) } fn path_generic_args( self, print_prefix: impl FnOnce(Self) -> Result, _args: &[GenericArg<'tcx>], ) -> Result { print_prefix(self) } } AbsolutePathPrinter { tcx: self.tcx } .print_def_path(def_id, &[]) .unwrap() } } impl<'a, 'tcx> LayoutOf for LateContext<'a, 'tcx> { type Ty = Ty<'tcx>; type TyLayout = Result, LayoutError<'tcx>>; fn layout_of(&self, ty: Ty<'tcx>) -> Self::TyLayout { self.tcx.layout_of(self.param_env.and(ty)) } } impl<'a, 'tcx, T: LateLintPass<'a, 'tcx>> LateContextAndPass<'a, 'tcx, T> { /// Merge the lints specified by any lint attributes into the /// current lint context, call the provided function, then reset the /// lints in effect to their previous state. fn with_lint_attrs(&mut self, id: hir::HirId, attrs: &'tcx [ast::Attribute], f: F) where F: FnOnce(&mut Self) { let prev = self.context.last_node_with_lint_attrs; self.context.last_node_with_lint_attrs = id; self.enter_attrs(attrs); f(self); self.exit_attrs(attrs); self.context.last_node_with_lint_attrs = prev; } fn with_param_env(&mut self, id: hir::HirId, f: F) where F: FnOnce(&mut Self), { let old_param_env = self.context.param_env; self.context.param_env = self.context.tcx.param_env( self.context.tcx.hir().local_def_id(id) ); f(self); self.context.param_env = old_param_env; } fn process_mod(&mut self, m: &'tcx hir::Mod<'tcx>, s: Span, n: hir::HirId) { lint_callback!(self, check_mod, m, s, n); hir_visit::walk_mod(self, m, n); lint_callback!(self, check_mod_post, m, s, n); } fn enter_attrs(&mut self, attrs: &'tcx [ast::Attribute]) { debug!("late context: enter_attrs({:?})", attrs); lint_callback!(self, enter_lint_attrs, attrs); } fn exit_attrs(&mut self, attrs: &'tcx [ast::Attribute]) { debug!("late context: exit_attrs({:?})", attrs); lint_callback!(self, exit_lint_attrs, attrs); } } impl<'a, 'tcx, T: LateLintPass<'a, 'tcx>> hir_visit::Visitor<'tcx> for LateContextAndPass<'a, 'tcx, T> { /// Because lints are scoped lexically, we want to walk nested /// items in the context of the outer item, so enable /// deep-walking. fn nested_visit_map<'this>(&'this mut self) -> hir_visit::NestedVisitorMap<'this, 'tcx> { hir_visit::NestedVisitorMap::All(&self.context.tcx.hir()) } fn visit_nested_body(&mut self, body: hir::BodyId) { let old_tables = self.context.tables; self.context.tables = self.context.tcx.body_tables(body); let body = self.context.tcx.hir().body(body); self.visit_body(body); self.context.tables = old_tables; } fn visit_param(&mut self, param: &'tcx hir::Param) { self.with_lint_attrs(param.hir_id, ¶m.attrs, |cx| { lint_callback!(cx, check_param, param); hir_visit::walk_param(cx, param); }); } fn visit_body(&mut self, body: &'tcx hir::Body<'tcx>) { lint_callback!(self, check_body, body); hir_visit::walk_body(self, body); lint_callback!(self, check_body_post, body); } fn visit_item(&mut self, it: &'tcx hir::Item<'tcx>) { let generics = self.context.generics.take(); self.context.generics = it.kind.generics(); self.with_lint_attrs(it.hir_id, &it.attrs, |cx| { cx.with_param_env(it.hir_id, |cx| { lint_callback!(cx, check_item, it); hir_visit::walk_item(cx, it); lint_callback!(cx, check_item_post, it); }); }); self.context.generics = generics; } fn visit_foreign_item(&mut self, it: &'tcx hir::ForeignItem<'tcx>) { self.with_lint_attrs(it.hir_id, &it.attrs, |cx| { cx.with_param_env(it.hir_id, |cx| { lint_callback!(cx, check_foreign_item, it); hir_visit::walk_foreign_item(cx, it); lint_callback!(cx, check_foreign_item_post, it); }); }) } fn visit_pat(&mut self, p: &'tcx hir::Pat) { lint_callback!(self, check_pat, p); hir_visit::walk_pat(self, p); } fn visit_expr(&mut self, e: &'tcx hir::Expr) { self.with_lint_attrs(e.hir_id, &e.attrs, |cx| { lint_callback!(cx, check_expr, e); hir_visit::walk_expr(cx, e); lint_callback!(cx, check_expr_post, e); }) } fn visit_stmt(&mut self, s: &'tcx hir::Stmt) { // statement attributes are actually just attributes on one of // - item // - local // - expression // so we keep track of lint levels there lint_callback!(self, check_stmt, s); hir_visit::walk_stmt(self, s); } fn visit_fn(&mut self, fk: hir_visit::FnKind<'tcx>, decl: &'tcx hir::FnDecl, body_id: hir::BodyId, span: Span, id: hir::HirId) { // Wrap in tables here, not just in visit_nested_body, // in order for `check_fn` to be able to use them. let old_tables = self.context.tables; self.context.tables = self.context.tcx.body_tables(body_id); let body = self.context.tcx.hir().body(body_id); lint_callback!(self, check_fn, fk, decl, body, span, id); hir_visit::walk_fn(self, fk, decl, body_id, span, id); lint_callback!(self, check_fn_post, fk, decl, body, span, id); self.context.tables = old_tables; } fn visit_variant_data(&mut self, s: &'tcx hir::VariantData<'tcx>, _: ast::Name, _: &'tcx hir::Generics, _: hir::HirId, _: Span) { lint_callback!(self, check_struct_def, s); hir_visit::walk_struct_def(self, s); lint_callback!(self, check_struct_def_post, s); } fn visit_struct_field(&mut self, s: &'tcx hir::StructField<'tcx>) { self.with_lint_attrs(s.hir_id, &s.attrs, |cx| { lint_callback!(cx, check_struct_field, s); hir_visit::walk_struct_field(cx, s); }) } fn visit_variant(&mut self, v: &'tcx hir::Variant<'tcx>, g: &'tcx hir::Generics, item_id: hir::HirId) { self.with_lint_attrs(v.id, &v.attrs, |cx| { lint_callback!(cx, check_variant, v); hir_visit::walk_variant(cx, v, g, item_id); lint_callback!(cx, check_variant_post, v); }) } fn visit_ty(&mut self, t: &'tcx hir::Ty) { lint_callback!(self, check_ty, t); hir_visit::walk_ty(self, t); } fn visit_name(&mut self, sp: Span, name: ast::Name) { lint_callback!(self, check_name, sp, name); } fn visit_mod(&mut self, m: &'tcx hir::Mod<'tcx>, s: Span, n: hir::HirId) { if !self.context.only_module { self.process_mod(m, s, n); } } fn visit_local(&mut self, l: &'tcx hir::Local) { self.with_lint_attrs(l.hir_id, &l.attrs, |cx| { lint_callback!(cx, check_local, l); hir_visit::walk_local(cx, l); }) } fn visit_block(&mut self, b: &'tcx hir::Block) { lint_callback!(self, check_block, b); hir_visit::walk_block(self, b); lint_callback!(self, check_block_post, b); } fn visit_arm(&mut self, a: &'tcx hir::Arm) { lint_callback!(self, check_arm, a); hir_visit::walk_arm(self, a); } fn visit_generic_param(&mut self, p: &'tcx hir::GenericParam) { lint_callback!(self, check_generic_param, p); hir_visit::walk_generic_param(self, p); } fn visit_generics(&mut self, g: &'tcx hir::Generics) { lint_callback!(self, check_generics, g); hir_visit::walk_generics(self, g); } fn visit_where_predicate(&mut self, p: &'tcx hir::WherePredicate) { lint_callback!(self, check_where_predicate, p); hir_visit::walk_where_predicate(self, p); } fn visit_poly_trait_ref(&mut self, t: &'tcx hir::PolyTraitRef, m: hir::TraitBoundModifier) { lint_callback!(self, check_poly_trait_ref, t, m); hir_visit::walk_poly_trait_ref(self, t, m); } fn visit_trait_item(&mut self, trait_item: &'tcx hir::TraitItem<'tcx>) { let generics = self.context.generics.take(); self.context.generics = Some(&trait_item.generics); self.with_lint_attrs(trait_item.hir_id, &trait_item.attrs, |cx| { cx.with_param_env(trait_item.hir_id, |cx| { lint_callback!(cx, check_trait_item, trait_item); hir_visit::walk_trait_item(cx, trait_item); lint_callback!(cx, check_trait_item_post, trait_item); }); }); self.context.generics = generics; } fn visit_impl_item(&mut self, impl_item: &'tcx hir::ImplItem<'tcx>) { let generics = self.context.generics.take(); self.context.generics = Some(&impl_item.generics); self.with_lint_attrs(impl_item.hir_id, &impl_item.attrs, |cx| { cx.with_param_env(impl_item.hir_id, |cx| { lint_callback!(cx, check_impl_item, impl_item); hir_visit::walk_impl_item(cx, impl_item); lint_callback!(cx, check_impl_item_post, impl_item); }); }); self.context.generics = generics; } fn visit_lifetime(&mut self, lt: &'tcx hir::Lifetime) { lint_callback!(self, check_lifetime, lt); hir_visit::walk_lifetime(self, lt); } fn visit_path(&mut self, p: &'tcx hir::Path, id: hir::HirId) { lint_callback!(self, check_path, p, id); hir_visit::walk_path(self, p); } fn visit_attribute(&mut self, attr: &'tcx ast::Attribute) { lint_callback!(self, check_attribute, attr); } } impl<'a, T: EarlyLintPass> ast_visit::Visitor<'a> for EarlyContextAndPass<'a, T> { fn visit_param(&mut self, param: &'a ast::Param) { self.with_lint_attrs(param.id, ¶m.attrs, |cx| { run_early_pass!(cx, check_param, param); ast_visit::walk_param(cx, param); }); } fn visit_item(&mut self, it: &'a ast::Item) { self.with_lint_attrs(it.id, &it.attrs, |cx| { run_early_pass!(cx, check_item, it); ast_visit::walk_item(cx, it); run_early_pass!(cx, check_item_post, it); }) } fn visit_foreign_item(&mut self, it: &'a ast::ForeignItem) { self.with_lint_attrs(it.id, &it.attrs, |cx| { run_early_pass!(cx, check_foreign_item, it); ast_visit::walk_foreign_item(cx, it); run_early_pass!(cx, check_foreign_item_post, it); }) } fn visit_pat(&mut self, p: &'a ast::Pat) { run_early_pass!(self, check_pat, p); self.check_id(p.id); ast_visit::walk_pat(self, p); run_early_pass!(self, check_pat_post, p); } fn visit_expr(&mut self, e: &'a ast::Expr) { self.with_lint_attrs(e.id, &e.attrs, |cx| { run_early_pass!(cx, check_expr, e); ast_visit::walk_expr(cx, e); }) } fn visit_stmt(&mut self, s: &'a ast::Stmt) { run_early_pass!(self, check_stmt, s); self.check_id(s.id); ast_visit::walk_stmt(self, s); } fn visit_fn(&mut self, fk: ast_visit::FnKind<'a>, decl: &'a ast::FnDecl, span: Span, id: ast::NodeId) { run_early_pass!(self, check_fn, fk, decl, span, id); self.check_id(id); ast_visit::walk_fn(self, fk, decl, span); run_early_pass!(self, check_fn_post, fk, decl, span, id); } fn visit_variant_data(&mut self, s: &'a ast::VariantData) { run_early_pass!(self, check_struct_def, s); if let Some(ctor_hir_id) = s.ctor_id() { self.check_id(ctor_hir_id); } ast_visit::walk_struct_def(self, s); run_early_pass!(self, check_struct_def_post, s); } fn visit_struct_field(&mut self, s: &'a ast::StructField) { self.with_lint_attrs(s.id, &s.attrs, |cx| { run_early_pass!(cx, check_struct_field, s); ast_visit::walk_struct_field(cx, s); }) } fn visit_variant(&mut self, v: &'a ast::Variant) { self.with_lint_attrs(v.id, &v.attrs, |cx| { run_early_pass!(cx, check_variant, v); ast_visit::walk_variant(cx, v); run_early_pass!(cx, check_variant_post, v); }) } fn visit_ty(&mut self, t: &'a ast::Ty) { run_early_pass!(self, check_ty, t); self.check_id(t.id); ast_visit::walk_ty(self, t); } fn visit_ident(&mut self, ident: ast::Ident) { run_early_pass!(self, check_ident, ident); } fn visit_mod(&mut self, m: &'a ast::Mod, s: Span, _a: &[ast::Attribute], n: ast::NodeId) { run_early_pass!(self, check_mod, m, s, n); self.check_id(n); ast_visit::walk_mod(self, m); run_early_pass!(self, check_mod_post, m, s, n); } fn visit_local(&mut self, l: &'a ast::Local) { self.with_lint_attrs(l.id, &l.attrs, |cx| { run_early_pass!(cx, check_local, l); ast_visit::walk_local(cx, l); }) } fn visit_block(&mut self, b: &'a ast::Block) { run_early_pass!(self, check_block, b); self.check_id(b.id); ast_visit::walk_block(self, b); run_early_pass!(self, check_block_post, b); } fn visit_arm(&mut self, a: &'a ast::Arm) { run_early_pass!(self, check_arm, a); ast_visit::walk_arm(self, a); } fn visit_expr_post(&mut self, e: &'a ast::Expr) { run_early_pass!(self, check_expr_post, e); } fn visit_generic_param(&mut self, param: &'a ast::GenericParam) { run_early_pass!(self, check_generic_param, param); ast_visit::walk_generic_param(self, param); } fn visit_generics(&mut self, g: &'a ast::Generics) { run_early_pass!(self, check_generics, g); ast_visit::walk_generics(self, g); } fn visit_where_predicate(&mut self, p: &'a ast::WherePredicate) { run_early_pass!(self, check_where_predicate, p); ast_visit::walk_where_predicate(self, p); } fn visit_poly_trait_ref(&mut self, t: &'a ast::PolyTraitRef, m: &'a ast::TraitBoundModifier) { run_early_pass!(self, check_poly_trait_ref, t, m); ast_visit::walk_poly_trait_ref(self, t, m); } fn visit_trait_item(&mut self, trait_item: &'a ast::AssocItem) { self.with_lint_attrs(trait_item.id, &trait_item.attrs, |cx| { run_early_pass!(cx, check_trait_item, trait_item); ast_visit::walk_trait_item(cx, trait_item); run_early_pass!(cx, check_trait_item_post, trait_item); }); } fn visit_impl_item(&mut self, impl_item: &'a ast::AssocItem) { self.with_lint_attrs(impl_item.id, &impl_item.attrs, |cx| { run_early_pass!(cx, check_impl_item, impl_item); ast_visit::walk_impl_item(cx, impl_item); run_early_pass!(cx, check_impl_item_post, impl_item); }); } fn visit_lifetime(&mut self, lt: &'a ast::Lifetime) { run_early_pass!(self, check_lifetime, lt); self.check_id(lt.id); } fn visit_path(&mut self, p: &'a ast::Path, id: ast::NodeId) { run_early_pass!(self, check_path, p, id); self.check_id(id); ast_visit::walk_path(self, p); } fn visit_attribute(&mut self, attr: &'a ast::Attribute) { run_early_pass!(self, check_attribute, attr); } fn visit_mac_def(&mut self, mac: &'a ast::MacroDef, id: ast::NodeId) { run_early_pass!(self, check_mac_def, mac, id); self.check_id(id); } fn visit_mac(&mut self, mac: &'a ast::Mac) { // FIXME(#54110): So, this setup isn't really right. I think // that (a) the libsyntax visitor ought to be doing this as // part of `walk_mac`, and (b) we should be calling // `visit_path`, *but* that would require a `NodeId`, and I // want to get #53686 fixed quickly. -nmatsakis ast_visit::walk_path(self, &mac.path); run_early_pass!(self, check_mac, mac); } } struct LateLintPassObjects<'a> { lints: &'a mut [LateLintPassObject], } #[allow(rustc::lint_pass_impl_without_macro)] impl LintPass for LateLintPassObjects<'_> { fn name(&self) -> &'static str { panic!() } } macro_rules! expand_late_lint_pass_impl_methods { ([$a:tt, $hir:tt], [$($(#[$attr:meta])* fn $name:ident($($param:ident: $arg:ty),*);)*]) => ( $(fn $name(&mut self, context: &LateContext<$a, $hir>, $($param: $arg),*) { for obj in self.lints.iter_mut() { obj.$name(context, $($param),*); } })* ) } macro_rules! late_lint_pass_impl { ([], [$hir:tt], $methods:tt) => ( impl LateLintPass<'a, $hir> for LateLintPassObjects<'_> { expand_late_lint_pass_impl_methods!(['a, $hir], $methods); } ) } late_lint_methods!(late_lint_pass_impl, [], ['tcx]); fn late_lint_mod_pass<'tcx, T: for<'a> LateLintPass<'a, 'tcx>>( tcx: TyCtxt<'tcx>, module_def_id: DefId, pass: T, ) { let access_levels = &tcx.privacy_access_levels(LOCAL_CRATE); let context = LateContext { tcx, tables: &ty::TypeckTables::empty(None), param_env: ty::ParamEnv::empty(), access_levels, lint_store: &tcx.lint_store, last_node_with_lint_attrs: tcx.hir().as_local_hir_id(module_def_id).unwrap(), generics: None, only_module: true, }; let mut cx = LateContextAndPass { context, pass }; let (module, span, hir_id) = tcx.hir().get_module(module_def_id); cx.process_mod(module, span, hir_id); // Visit the crate attributes if hir_id == hir::CRATE_HIR_ID { walk_list!(cx, visit_attribute, tcx.hir().attrs(hir::CRATE_HIR_ID)); } } pub fn late_lint_mod<'tcx, T: for<'a> LateLintPass<'a, 'tcx>>( tcx: TyCtxt<'tcx>, module_def_id: DefId, builtin_lints: T, ) { if tcx.sess.opts.debugging_opts.no_interleave_lints { // These passes runs in late_lint_crate with -Z no_interleave_lints return; } late_lint_mod_pass(tcx, module_def_id, builtin_lints); let mut passes: Vec<_> = tcx.lint_store.late_module_passes .iter().map(|pass| (pass)()).collect(); if !passes.is_empty() { late_lint_mod_pass(tcx, module_def_id, LateLintPassObjects { lints: &mut passes[..] }); } } fn late_lint_pass_crate<'tcx, T: for<'a> LateLintPass<'a, 'tcx>>(tcx: TyCtxt<'tcx>, pass: T) { let access_levels = &tcx.privacy_access_levels(LOCAL_CRATE); let krate = tcx.hir().krate(); let context = LateContext { tcx, tables: &ty::TypeckTables::empty(None), param_env: ty::ParamEnv::empty(), access_levels, lint_store: &tcx.lint_store, last_node_with_lint_attrs: hir::CRATE_HIR_ID, generics: None, only_module: false, }; let mut cx = LateContextAndPass { context, pass }; // Visit the whole crate. cx.with_lint_attrs(hir::CRATE_HIR_ID, &krate.attrs, |cx| { // since the root module isn't visited as an item (because it isn't an // item), warn for it here. lint_callback!(cx, check_crate, krate); hir_visit::walk_crate(cx, krate); lint_callback!(cx, check_crate_post, krate); }) } fn late_lint_crate<'tcx, T: for<'a> LateLintPass<'a, 'tcx>>(tcx: TyCtxt<'tcx>, builtin_lints: T) { let mut passes = tcx.lint_store .late_passes.iter().map(|p| (p)()).collect::>(); if !tcx.sess.opts.debugging_opts.no_interleave_lints { if !passes.is_empty() { late_lint_pass_crate(tcx, LateLintPassObjects { lints: &mut passes[..] }); } late_lint_pass_crate(tcx, builtin_lints); } else { for pass in &mut passes { time(tcx.sess, &format!("running late lint: {}", pass.name()), || { late_lint_pass_crate(tcx, LateLintPassObjects { lints: slice::from_mut(pass) }); }); } let mut passes: Vec<_> = tcx.lint_store.late_module_passes .iter().map(|pass| (pass)()).collect(); for pass in &mut passes { time(tcx.sess, &format!("running late module lint: {}", pass.name()), || { late_lint_pass_crate(tcx, LateLintPassObjects { lints: slice::from_mut(pass) }); }); } } } /// Performs lint checking on a crate. pub fn check_crate<'tcx, T: for<'a> LateLintPass<'a, 'tcx>>( tcx: TyCtxt<'tcx>, builtin_lints: impl FnOnce() -> T + Send, ) { join(|| { time(tcx.sess, "crate lints", || { // Run whole crate non-incremental lints late_lint_crate(tcx, builtin_lints()); }); }, || { time(tcx.sess, "module lints", || { // Run per-module lints par_iter(&tcx.hir().krate().modules).for_each(|(&module, _)| { tcx.ensure().lint_mod(tcx.hir().local_def_id(module)); }); }); }); } struct EarlyLintPassObjects<'a> { lints: &'a mut [EarlyLintPassObject], } #[allow(rustc::lint_pass_impl_without_macro)] impl LintPass for EarlyLintPassObjects<'_> { fn name(&self) -> &'static str { panic!() } } macro_rules! expand_early_lint_pass_impl_methods { ([$($(#[$attr:meta])* fn $name:ident($($param:ident: $arg:ty),*);)*]) => ( $(fn $name(&mut self, context: &EarlyContext<'_>, $($param: $arg),*) { for obj in self.lints.iter_mut() { obj.$name(context, $($param),*); } })* ) } macro_rules! early_lint_pass_impl { ([], [$($methods:tt)*]) => ( impl EarlyLintPass for EarlyLintPassObjects<'_> { expand_early_lint_pass_impl_methods!([$($methods)*]); } ) } early_lint_methods!(early_lint_pass_impl, []); fn early_lint_crate( sess: &Session, lint_store: &LintStore, krate: &ast::Crate, pass: T, buffered: LintBuffer, warn_about_weird_lints: bool, ) -> LintBuffer { let mut cx = EarlyContextAndPass { context: EarlyContext::new(sess, lint_store, krate, buffered, warn_about_weird_lints), pass, }; // Visit the whole crate. cx.with_lint_attrs(ast::CRATE_NODE_ID, &krate.attrs, |cx| { // since the root module isn't visited as an item (because it isn't an // item), warn for it here. run_early_pass!(cx, check_crate, krate); ast_visit::walk_crate(cx, krate); run_early_pass!(cx, check_crate_post, krate); }); cx.context.buffered } pub fn check_ast_crate( sess: &Session, lint_store: &LintStore, krate: &ast::Crate, pre_expansion: bool, lint_buffer: Option, builtin_lints: T, ) { let mut passes: Vec<_> = if pre_expansion { lint_store.pre_expansion_passes.iter().map(|p| (p)()).collect() } else { lint_store.early_passes.iter().map(|p| (p)()).collect() }; let mut buffered = lint_buffer.unwrap_or_default(); if !sess.opts.debugging_opts.no_interleave_lints { buffered = early_lint_crate(sess, lint_store, krate, builtin_lints, buffered, pre_expansion); if !passes.is_empty() { buffered = early_lint_crate( sess, lint_store, krate, EarlyLintPassObjects { lints: &mut passes[..] }, buffered, pre_expansion, ); } } else { for pass in &mut passes { buffered = time(sess, &format!("running lint: {}", pass.name()), || { early_lint_crate( sess, lint_store, krate, EarlyLintPassObjects { lints: slice::from_mut(pass) }, buffered, pre_expansion, ) }); } } // All of the buffered lints should have been emitted at this point. // If not, that means that we somehow buffered a lint for a node id // that was not lint-checked (perhaps it doesn't exist?). This is a bug. // // Rustdoc runs everybody-loops before the early lints and removes // function bodies, so it's totally possible for linted // node ids to not exist (e.g., macros defined within functions for the // unused_macro lint) anymore. So we only run this check // when we're not in rustdoc mode. (see issue #47639) if !sess.opts.actually_rustdoc { for (_id, lints) in buffered.map { for early_lint in lints { sess.delay_span_bug(early_lint.span, "failed to process buffered lint here"); } } } }