use std::cmp; use crate::hir::HirId; use crate::ich::StableHashingContext; use crate::lint::builtin; use crate::lint::context::CheckLintNameResult; use crate::lint::{self, Lint, LintId, Level, LintSource}; use crate::session::Session; use crate::util::nodemap::FxHashMap; use errors::{Applicability, DiagnosticBuilder}; use rustc_data_structures::stable_hasher::{HashStable, ToStableHashKey, StableHasher, StableHasherResult}; use syntax::ast; use syntax::attr; use syntax::feature_gate; use syntax::source_map::MultiSpan; use syntax::symbol::Symbol; pub struct LintLevelSets { list: Vec, lint_cap: Level, } enum LintSet { CommandLine { // -A,-W,-D flags, a `Symbol` for the flag itself and `Level` for which // flag. specs: FxHashMap, }, Node { specs: FxHashMap, parent: u32, }, } impl LintLevelSets { pub fn new(sess: &Session) -> LintLevelSets { let mut me = LintLevelSets { list: Vec::new(), lint_cap: Level::Forbid, }; me.process_command_line(sess); return me } pub fn builder(sess: &Session) -> LintLevelsBuilder<'_> { LintLevelsBuilder::new(sess, LintLevelSets::new(sess)) } fn process_command_line(&mut self, sess: &Session) { let store = sess.lint_store.borrow(); let mut specs = FxHashMap::default(); self.lint_cap = sess.opts.lint_cap.unwrap_or(Level::Forbid); for &(ref lint_name, level) in &sess.opts.lint_opts { store.check_lint_name_cmdline(sess, &lint_name, level); // If the cap is less than this specified level, e.g., if we've got // `--cap-lints allow` but we've also got `-D foo` then we ignore // this specification as the lint cap will set it to allow anyway. let level = cmp::min(level, self.lint_cap); let lint_flag_val = Symbol::intern(lint_name); let ids = match store.find_lints(&lint_name) { Ok(ids) => ids, Err(_) => continue, // errors handled in check_lint_name_cmdline above }; for id in ids { let src = LintSource::CommandLine(lint_flag_val); specs.insert(id, (level, src)); } } self.list.push(LintSet::CommandLine { specs: specs, }); } fn get_lint_level(&self, lint: &'static Lint, idx: u32, aux: Option<&FxHashMap>, sess: &Session) -> (Level, LintSource) { let (level, mut src) = self.get_lint_id_level(LintId::of(lint), idx, aux); // If `level` is none then we actually assume the default level for this // lint. let mut level = level.unwrap_or_else(|| lint.default_level(sess)); // If we're about to issue a warning, check at the last minute for any // directives against the warnings "lint". If, for example, there's an // `allow(warnings)` in scope then we want to respect that instead. if level == Level::Warn { let (warnings_level, warnings_src) = self.get_lint_id_level(LintId::of(lint::builtin::WARNINGS), idx, aux); if let Some(configured_warning_level) = warnings_level { if configured_warning_level != Level::Warn { level = configured_warning_level; src = warnings_src; } } } // Ensure that we never exceed the `--cap-lints` argument. level = cmp::min(level, self.lint_cap); if let Some(driver_level) = sess.driver_lint_caps.get(&LintId::of(lint)) { // Ensure that we never exceed driver level. level = cmp::min(*driver_level, level); } return (level, src) } fn get_lint_id_level(&self, id: LintId, mut idx: u32, aux: Option<&FxHashMap>) -> (Option, LintSource) { if let Some(specs) = aux { if let Some(&(level, src)) = specs.get(&id) { return (Some(level), src) } } loop { match self.list[idx as usize] { LintSet::CommandLine { ref specs } => { if let Some(&(level, src)) = specs.get(&id) { return (Some(level), src) } return (None, LintSource::Default) } LintSet::Node { ref specs, parent } => { if let Some(&(level, src)) = specs.get(&id) { return (Some(level), src) } idx = parent; } } } } } pub struct LintLevelsBuilder<'a> { sess: &'a Session, sets: LintLevelSets, id_to_set: FxHashMap, cur: u32, warn_about_weird_lints: bool, } pub struct BuilderPush { prev: u32, pub(super) changed: bool, } impl<'a> LintLevelsBuilder<'a> { pub fn new(sess: &'a Session, sets: LintLevelSets) -> LintLevelsBuilder<'a> { assert_eq!(sets.list.len(), 1); LintLevelsBuilder { sess, sets, cur: 0, id_to_set: Default::default(), warn_about_weird_lints: sess.buffered_lints.borrow().is_some(), } } /// Pushes a list of AST lint attributes onto this context. /// /// This function will return a `BuilderPush` object which should be passed /// to `pop` when this scope for the attributes provided is exited. /// /// This function will perform a number of tasks: /// /// * It'll validate all lint-related attributes in `attrs` /// * It'll mark all lint-related attributes as used /// * Lint levels will be updated based on the attributes provided /// * Lint attributes are validated, e.g., a #[forbid] can't be switched to /// #[allow] /// /// Don't forget to call `pop`! pub fn push(&mut self, attrs: &[ast::Attribute]) -> BuilderPush { let mut specs = FxHashMap::default(); let store = self.sess.lint_store.borrow(); let sess = self.sess; let bad_attr = |span| { struct_span_err!(sess, span, E0452, "malformed lint attribute") }; for attr in attrs { let level = match Level::from_str(&attr.name_or_empty()) { None => continue, Some(lvl) => lvl, }; let meta = unwrap_or!(attr.meta(), continue); attr::mark_used(attr); let mut metas = if let Some(metas) = meta.meta_item_list() { metas } else { continue; }; if metas.is_empty() { // FIXME (#55112): issue unused-attributes lint for `#[level()]` continue; } // Before processing the lint names, look for a reason (RFC 2383) // at the end. let mut reason = None; let tail_li = &metas[metas.len()-1]; if let Some(item) = tail_li.meta_item() { match item.node { ast::MetaItemKind::Word => {} // actual lint names handled later ast::MetaItemKind::NameValue(ref name_value) => { if item.path == "reason" { // found reason, reslice meta list to exclude it metas = &metas[0..metas.len()-1]; // FIXME (#55112): issue unused-attributes lint if we thereby // don't have any lint names (`#[level(reason = "foo")]`) if let ast::LitKind::Str(rationale, _) = name_value.node { if !self.sess.features_untracked().lint_reasons { feature_gate::emit_feature_err( &self.sess.parse_sess, "lint_reasons", item.span, feature_gate::GateIssue::Language, "lint reasons are experimental" ); } reason = Some(rationale); } else { let mut err = bad_attr(name_value.span); err.help("reason must be a string literal"); err.emit(); } } else { let mut err = bad_attr(item.span); err.emit(); } }, ast::MetaItemKind::List(_) => { let mut err = bad_attr(item.span); err.emit(); } } } for li in metas { let meta_item = match li.meta_item() { Some(meta_item) if meta_item.is_word() => meta_item, _ => { let mut err = bad_attr(li.span()); if let Some(item) = li.meta_item() { if let ast::MetaItemKind::NameValue(_) = item.node { if item.path == "reason" { err.help("reason in lint attribute must come last"); } } } err.emit(); continue; } }; let tool_name = if meta_item.path.segments.len() > 1 { let tool_ident = meta_item.path.segments[0].ident; if !attr::is_known_lint_tool(tool_ident) { span_err!( sess, tool_ident.span, E0710, "an unknown tool name found in scoped lint: `{}`", meta_item.path ); continue; } Some(tool_ident.as_str()) } else { None }; let name = meta_item.path.segments.last().expect("empty lint name").ident.name; match store.check_lint_name(&name.as_str(), tool_name) { CheckLintNameResult::Ok(ids) => { let src = LintSource::Node(name, li.span(), reason); for id in ids { specs.insert(*id, (level, src)); } } CheckLintNameResult::Tool(result) => { match result { Ok(ids) => { let complete_name = &format!("{}::{}", tool_name.unwrap(), name); let src = LintSource::Node( Symbol::intern(complete_name), li.span(), reason ); for id in ids { specs.insert(*id, (level, src)); } } Err((Some(ids), new_lint_name)) => { let lint = builtin::RENAMED_AND_REMOVED_LINTS; let (lvl, src) = self.sets .get_lint_level(lint, self.cur, Some(&specs), &sess); let msg = format!( "lint name `{}` is deprecated \ and may not have an effect in the future. \ Also `cfg_attr(cargo-clippy)` won't be necessary anymore", name ); let mut err = lint::struct_lint_level( self.sess, lint, lvl, src, Some(li.span().into()), &msg, ); err.span_suggestion( li.span(), "change it to", new_lint_name.to_string(), Applicability::MachineApplicable, ).emit(); let src = LintSource::Node( Symbol::intern(&new_lint_name), li.span(), reason ); for id in ids { specs.insert(*id, (level, src)); } } Err((None, _)) => { // If Tool(Err(None, _)) is returned, 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`. To detect // this is the responsibility of the lint tool. } } } _ if !self.warn_about_weird_lints => {} CheckLintNameResult::Warning(msg, renamed) => { let lint = builtin::RENAMED_AND_REMOVED_LINTS; let (level, src) = self.sets.get_lint_level(lint, self.cur, Some(&specs), &sess); let mut err = lint::struct_lint_level(self.sess, lint, level, src, Some(li.span().into()), &msg); if let Some(new_name) = renamed { err.span_suggestion( li.span(), "use the new name", new_name, Applicability::MachineApplicable ); } err.emit(); } CheckLintNameResult::NoLint(suggestion) => { let lint = builtin::UNKNOWN_LINTS; let (level, src) = self.sets.get_lint_level(lint, self.cur, Some(&specs), self.sess); let msg = format!("unknown lint: `{}`", name); let mut db = lint::struct_lint_level(self.sess, lint, level, src, Some(li.span().into()), &msg); if let Some(suggestion) = suggestion { db.span_suggestion( li.span(), "did you mean", suggestion.to_string(), Applicability::MachineApplicable, ); } db.emit(); } } } } for (id, &(level, ref src)) in specs.iter() { if level == Level::Forbid { continue } let forbid_src = match self.sets.get_lint_id_level(*id, self.cur, None) { (Some(Level::Forbid), src) => src, _ => continue, }; let forbidden_lint_name = match forbid_src { LintSource::Default => id.to_string(), LintSource::Node(name, _, _) => name.to_string(), LintSource::CommandLine(name) => name.to_string(), }; let (lint_attr_name, lint_attr_span) = match *src { LintSource::Node(name, span, _) => (name, span), _ => continue, }; let mut diag_builder = struct_span_err!(self.sess, lint_attr_span, E0453, "{}({}) overruled by outer forbid({})", level.as_str(), lint_attr_name, forbidden_lint_name); diag_builder.span_label(lint_attr_span, "overruled by previous forbid"); match forbid_src { LintSource::Default => {}, LintSource::Node(_, forbid_source_span, reason) => { diag_builder.span_label(forbid_source_span, "`forbid` level set here"); if let Some(rationale) = reason { diag_builder.note(&rationale.as_str()); } }, LintSource::CommandLine(_) => { diag_builder.note("`forbid` lint level was set on command line"); } } diag_builder.emit(); // don't set a separate error for every lint in the group break } let prev = self.cur; if specs.len() > 0 { self.cur = self.sets.list.len() as u32; self.sets.list.push(LintSet::Node { specs: specs, parent: prev, }); } BuilderPush { prev: prev, changed: prev != self.cur, } } /// Called after `push` when the scope of a set of attributes are exited. pub fn pop(&mut self, push: BuilderPush) { self.cur = push.prev; } /// Used to emit a lint-related diagnostic based on the current state of /// this lint context. pub fn struct_lint(&self, lint: &'static Lint, span: Option, msg: &str) -> DiagnosticBuilder<'a> { let (level, src) = self.sets.get_lint_level(lint, self.cur, None, self.sess); lint::struct_lint_level(self.sess, lint, level, src, span, msg) } /// Registers the ID provided with the current set of lints stored in /// this context. pub fn register_id(&mut self, id: HirId) { self.id_to_set.insert(id, self.cur); } pub fn build(self) -> LintLevelSets { self.sets } pub fn build_map(self) -> LintLevelMap { LintLevelMap { sets: self.sets, id_to_set: self.id_to_set, } } } pub struct LintLevelMap { sets: LintLevelSets, id_to_set: FxHashMap, } impl LintLevelMap { /// If the `id` was previously registered with `register_id` when building /// this `LintLevelMap` this returns the corresponding lint level and source /// of the lint level for the lint provided. /// /// If the `id` was not previously registered, returns `None`. If `None` is /// returned then the parent of `id` should be acquired and this function /// should be called again. pub fn level_and_source(&self, lint: &'static Lint, id: HirId, session: &Session) -> Option<(Level, LintSource)> { self.id_to_set.get(&id).map(|idx| { self.sets.get_lint_level(lint, *idx, None, session) }) } } impl<'a> HashStable> for LintLevelMap { #[inline] fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) { let LintLevelMap { ref sets, ref id_to_set, } = *self; id_to_set.hash_stable(hcx, hasher); let LintLevelSets { ref list, lint_cap, } = *sets; lint_cap.hash_stable(hcx, hasher); hcx.while_hashing_spans(true, |hcx| { list.len().hash_stable(hcx, hasher); // We are working under the assumption here that the list of // lint-sets is built in a deterministic order. for lint_set in list { ::std::mem::discriminant(lint_set).hash_stable(hcx, hasher); match *lint_set { LintSet::CommandLine { ref specs } => { specs.hash_stable(hcx, hasher); } LintSet::Node { ref specs, parent } => { specs.hash_stable(hcx, hasher); parent.hash_stable(hcx, hasher); } } } }) } } impl HashStable for LintId { #[inline] fn hash_stable(&self, hcx: &mut HCX, hasher: &mut StableHasher) { self.lint_name_raw().hash_stable(hcx, hasher); } } impl ToStableHashKey for LintId { type KeyType = &'static str; #[inline] fn to_stable_hash_key(&self, _: &HCX) -> &'static str { self.lint_name_raw() } }