1 use crate::context::{CheckLintNameResult, LintStore};
2 use crate::late::unerased_lint_store;
4 use rustc_ast::unwrap_or;
5 use rustc_ast_pretty::pprust;
6 use rustc_data_structures::fx::FxHashMap;
7 use rustc_errors::{struct_span_err, Applicability, DiagnosticBuilder};
9 use rustc_hir::{intravisit, HirId, CRATE_HIR_ID};
10 use rustc_middle::hir::map::Map;
11 use rustc_middle::lint::LevelAndSource;
12 use rustc_middle::lint::LintDiagnosticBuilder;
13 use rustc_middle::lint::{
14 struct_lint_level, LintLevelMap, LintLevelSets, LintLevelSource, LintSet, LintStackIndex,
17 use rustc_middle::ty::query::Providers;
18 use rustc_middle::ty::TyCtxt;
19 use rustc_session::lint::{
20 builtin::{self, FORBIDDEN_LINT_GROUPS},
23 use rustc_session::parse::feature_err;
24 use rustc_session::Session;
25 use rustc_span::symbol::{sym, Symbol};
26 use rustc_span::{source_map::MultiSpan, Span, DUMMY_SP};
29 fn lint_levels(tcx: TyCtxt<'_>, (): ()) -> LintLevelMap {
30 let store = unerased_lint_store(tcx);
31 let crate_attrs = tcx.hir().attrs(CRATE_HIR_ID);
32 let levels = LintLevelsBuilder::new(tcx.sess, false, &store, crate_attrs);
33 let mut builder = LintLevelMapBuilder { levels, tcx, store };
34 let krate = tcx.hir().krate();
36 builder.levels.id_to_set.reserve(krate.owners.len() + 1);
38 let push = builder.levels.push(tcx.hir().attrs(hir::CRATE_HIR_ID), &store, true);
39 builder.levels.register_id(hir::CRATE_HIR_ID);
40 for macro_def in krate.exported_macros() {
41 builder.levels.register_id(macro_def.hir_id());
43 intravisit::walk_crate(&mut builder, krate);
44 builder.levels.pop(push);
46 builder.levels.build_map()
49 pub struct LintLevelsBuilder<'s> {
52 id_to_set: FxHashMap<HirId, LintStackIndex>,
54 warn_about_weird_lints: bool,
56 crate_attrs: &'s [ast::Attribute],
59 pub struct BuilderPush {
64 impl<'s> LintLevelsBuilder<'s> {
67 warn_about_weird_lints: bool,
69 crate_attrs: &'s [ast::Attribute],
71 let mut builder = LintLevelsBuilder {
73 sets: LintLevelSets::new(),
75 id_to_set: Default::default(),
76 warn_about_weird_lints,
80 builder.process_command_line(sess, store);
81 assert_eq!(builder.sets.list.len(), 1);
85 fn process_command_line(&mut self, sess: &Session, store: &LintStore) {
86 let mut specs = FxHashMap::default();
87 self.sets.lint_cap = sess.opts.lint_cap.unwrap_or(Level::Forbid);
89 for &(ref lint_name, level) in &sess.opts.lint_opts {
90 store.check_lint_name_cmdline(sess, &lint_name, level, self.crate_attrs);
91 let orig_level = level;
92 let lint_flag_val = Symbol::intern(lint_name);
94 let ids = match store.find_lints(&lint_name) {
96 Err(_) => continue, // errors handled in check_lint_name_cmdline above
99 // ForceWarn and Forbid cannot be overriden
100 if let Some((Level::ForceWarn | Level::Forbid, _)) = specs.get(&id) {
104 self.check_gated_lint(id, DUMMY_SP);
105 let src = LintLevelSource::CommandLine(lint_flag_val, orig_level);
106 specs.insert(id, (level, src));
110 self.cur = self.sets.list.push(LintSet { specs, parent: COMMAND_LINE });
113 /// Attempts to insert the `id` to `level_src` map entry. If unsuccessful
114 /// (e.g. if a forbid was already inserted on the same scope), then emits a
115 /// diagnostic with no change to `specs`.
118 specs: &mut FxHashMap<LintId, LevelAndSource>,
120 (level, src): LevelAndSource,
122 let (old_level, old_src) =
123 self.sets.get_lint_level(id.lint, self.cur, Some(&specs), &self.sess);
124 // Setting to a non-forbid level is an error if the lint previously had
125 // a forbid level. Note that this is not necessarily true even with a
126 // `#[forbid(..)]` attribute present, as that is overriden by `--cap-lints`.
128 // This means that this only errors if we're truly lowering the lint
129 // level from forbid.
130 if level != Level::Forbid {
131 if let Level::Forbid = old_level {
132 // Backwards compatibility check:
134 // We used to not consider `forbid(lint_group)`
135 // as preventing `allow(lint)` for some lint `lint` in
136 // `lint_group`. For now, issue a future-compatibility
137 // warning for this case.
138 let id_name = id.lint.name_lower();
139 let fcw_warning = match old_src {
140 LintLevelSource::Default => false,
141 LintLevelSource::Node(symbol, _, _) => self.store.is_lint_group(symbol),
142 LintLevelSource::CommandLine(symbol, _) => self.store.is_lint_group(symbol),
145 "fcw_warning={:?}, specs.get(&id) = {:?}, old_src={:?}, id_name={:?}",
146 fcw_warning, specs, old_src, id_name
149 let decorate_diag_builder = |mut diag_builder: DiagnosticBuilder<'_>| {
150 diag_builder.span_label(src.span(), "overruled by previous forbid");
152 LintLevelSource::Default => {
153 diag_builder.note(&format!(
154 "`forbid` lint level is the default for {}",
158 LintLevelSource::Node(_, forbid_source_span, reason) => {
159 diag_builder.span_label(forbid_source_span, "`forbid` level set here");
160 if let Some(rationale) = reason {
161 diag_builder.note(&rationale.as_str());
164 LintLevelSource::CommandLine(_, _) => {
165 diag_builder.note("`forbid` lint level was set on command line");
171 let diag_builder = struct_span_err!(
175 "{}({}) incompatible with previous forbid",
179 decorate_diag_builder(diag_builder);
182 FORBIDDEN_LINT_GROUPS,
183 Some(src.span().into()),
185 let diag_builder = diag_builder.build(&format!(
186 "{}({}) incompatible with previous forbid",
190 decorate_diag_builder(diag_builder);
195 // Retain the forbid lint level, unless we are
196 // issuing a FCW. In the FCW case, we want to
197 // respect the new setting.
203 if let Level::ForceWarn = old_level {
204 specs.insert(id, (old_level, old_src));
206 specs.insert(id, (level, src));
210 /// Pushes a list of AST lint attributes onto this context.
212 /// This function will return a `BuilderPush` object which should be passed
213 /// to `pop` when this scope for the attributes provided is exited.
215 /// This function will perform a number of tasks:
217 /// * It'll validate all lint-related attributes in `attrs`
218 /// * It'll mark all lint-related attributes as used
219 /// * Lint levels will be updated based on the attributes provided
220 /// * Lint attributes are validated, e.g., a `#[forbid]` can't be switched to
223 /// Don't forget to call `pop`!
226 attrs: &[ast::Attribute],
230 let mut specs = FxHashMap::default();
231 let sess = self.sess;
232 let bad_attr = |span| struct_span_err!(sess, span, E0452, "malformed lint attribute input");
234 let level = match Level::from_symbol(attr.name_or_empty()) {
239 self.sess.mark_attr_used(attr);
241 let mut metas = unwrap_or!(attr.meta_item_list(), continue);
243 if metas.is_empty() {
244 // FIXME (#55112): issue unused-attributes lint for `#[level()]`
248 // Before processing the lint names, look for a reason (RFC 2383)
250 let mut reason = None;
251 let tail_li = &metas[metas.len() - 1];
252 if let Some(item) = tail_li.meta_item() {
254 ast::MetaItemKind::Word => {} // actual lint names handled later
255 ast::MetaItemKind::NameValue(ref name_value) => {
256 if item.path == sym::reason {
257 // FIXME (#55112): issue unused-attributes lint if we thereby
258 // don't have any lint names (`#[level(reason = "foo")]`)
259 if let ast::LitKind::Str(rationale, _) = name_value.kind {
260 if !self.sess.features_untracked().lint_reasons {
262 &self.sess.parse_sess,
265 "lint reasons are experimental",
269 reason = Some(rationale);
271 bad_attr(name_value.span)
272 .span_label(name_value.span, "reason must be a string literal")
275 // found reason, reslice meta list to exclude it
276 metas.pop().unwrap();
279 .span_label(item.span, "bad attribute argument")
283 ast::MetaItemKind::List(_) => {
284 bad_attr(item.span).span_label(item.span, "bad attribute argument").emit();
291 let mut meta_item = match li {
292 ast::NestedMetaItem::MetaItem(meta_item) if meta_item.is_word() => meta_item,
294 let mut err = bad_attr(sp);
295 let mut add_label = true;
296 if let Some(item) = li.meta_item() {
297 if let ast::MetaItemKind::NameValue(_) = item.kind {
298 if item.path == sym::reason {
299 err.span_label(sp, "reason in lint attribute must come last");
305 err.span_label(sp, "bad attribute argument");
311 let tool_ident = if meta_item.path.segments.len() > 1 {
312 Some(meta_item.path.segments.remove(0).ident)
316 let tool_name = tool_ident.map(|ident| ident.name);
317 let name = pprust::path_to_string(&meta_item.path);
318 let lint_result = store.check_lint_name(sess, &name, tool_name, self.crate_attrs);
320 CheckLintNameResult::Ok(ids) => {
321 let src = LintLevelSource::Node(
322 meta_item.path.segments.last().expect("empty lint name").ident.name,
327 self.check_gated_lint(id, attr.span);
328 self.insert_spec(&mut specs, id, (level, src));
332 CheckLintNameResult::Tool(result) => {
336 &format!("{}::{}", tool_ident.unwrap().name, name);
337 let src = LintLevelSource::Node(
338 Symbol::intern(complete_name),
343 self.insert_spec(&mut specs, *id, (level, src));
346 Err((Some(ids), ref new_lint_name)) => {
347 let lint = builtin::RENAMED_AND_REMOVED_LINTS;
349 self.sets.get_lint_level(lint, self.cur, Some(&specs), &sess);
358 "lint name `{}` is deprecated \
359 and may not have an effect in the future.",
366 new_lint_name.to_string(),
367 Applicability::MachineApplicable,
373 let src = LintLevelSource::Node(
374 Symbol::intern(&new_lint_name),
379 self.insert_spec(&mut specs, *id, (level, src));
383 // If Tool(Err(None, _)) is returned, then either the lint does not
384 // exist in the tool or the code was not compiled with the tool and
385 // therefore the lint was never added to the `LintStore`. To detect
386 // this is the responsibility of the lint tool.
391 &CheckLintNameResult::NoTool => {
392 let mut err = struct_span_err!(
394 tool_ident.map_or(DUMMY_SP, |ident| ident.span),
396 "unknown tool name `{}` found in scoped lint: `{}::{}`",
399 pprust::path_to_string(&meta_item.path),
401 if sess.is_nightly_build() {
403 "add `#![register_tool({})]` to the crate root",
411 _ if !self.warn_about_weird_lints => {}
413 CheckLintNameResult::Warning(msg, renamed) => {
414 let lint = builtin::RENAMED_AND_REMOVED_LINTS;
415 let (renamed_lint_level, src) =
416 self.sets.get_lint_level(lint, self.cur, Some(&specs), &sess);
424 let mut err = lint.build(&msg);
425 if let Some(new_name) = &renamed {
429 new_name.to_string(),
430 Applicability::MachineApplicable,
437 CheckLintNameResult::NoLint(suggestion) => {
438 let lint = builtin::UNKNOWN_LINTS;
440 self.sets.get_lint_level(lint, self.cur, Some(&specs), self.sess);
441 struct_lint_level(self.sess, lint, level, src, Some(sp.into()), |lint| {
442 let name = if let Some(tool_ident) = tool_ident {
443 format!("{}::{}", tool_ident.name, name)
447 let mut db = lint.build(&format!("unknown lint: `{}`", name));
448 if let Some(suggestion) = suggestion {
452 suggestion.to_string(),
453 Applicability::MachineApplicable,
460 // If this lint was renamed, apply the new lint instead of ignoring the attribute.
461 // This happens outside of the match because the new lint should be applied even if
462 // we don't warn about the name change.
463 if let CheckLintNameResult::Warning(_, Some(new_name)) = lint_result {
464 // Ignore any errors or warnings that happen because the new name is inaccurate
465 // NOTE: `new_name` already includes the tool name, so we don't have to add it again.
466 if let CheckLintNameResult::Ok(ids) =
467 store.check_lint_name(sess, &new_name, None, self.crate_attrs)
469 let src = LintLevelSource::Node(Symbol::intern(&new_name), sp, reason);
471 self.check_gated_lint(id, attr.span);
472 self.insert_spec(&mut specs, id, (level, src));
475 panic!("renamed lint does not exist: {}", new_name);
482 for (id, &(level, ref src)) in specs.iter() {
483 if !id.lint.crate_level_only {
487 let (lint_attr_name, lint_attr_span) = match *src {
488 LintLevelSource::Node(name, span, _) => (name, span),
492 let lint = builtin::UNUSED_ATTRIBUTES;
493 let (lint_level, lint_src) =
494 self.sets.get_lint_level(lint, self.cur, Some(&specs), self.sess);
500 Some(lint_attr_span.into()),
502 let mut db = lint.build(&format!(
503 "{}({}) is ignored unless specified at crate level",
510 // don't set a separate error for every lint in the group
516 if !specs.is_empty() {
517 self.cur = self.sets.list.push(LintSet { specs, parent: prev });
520 BuilderPush { prev, changed: prev != self.cur }
523 /// Checks if the lint is gated on a feature that is not enabled.
524 fn check_gated_lint(&self, lint_id: LintId, span: Span) {
525 if let Some(feature) = lint_id.lint.feature_gate {
526 if !self.sess.features_untracked().enabled(feature) {
528 &self.sess.parse_sess,
531 &format!("the `{}` lint is unstable", lint_id.lint.name_lower()),
538 /// Called after `push` when the scope of a set of attributes are exited.
539 pub fn pop(&mut self, push: BuilderPush) {
540 self.cur = push.prev;
543 /// Find the lint level for a lint.
544 pub fn lint_level(&self, lint: &'static Lint) -> (Level, LintLevelSource) {
545 self.sets.get_lint_level(lint, self.cur, None, self.sess)
548 /// Used to emit a lint-related diagnostic based on the current state of
549 /// this lint context.
553 span: Option<MultiSpan>,
554 decorate: impl for<'a> FnOnce(LintDiagnosticBuilder<'a>),
556 let (level, src) = self.lint_level(lint);
557 struct_lint_level(self.sess, lint, level, src, span, decorate)
560 /// Registers the ID provided with the current set of lints stored in
562 pub fn register_id(&mut self, id: HirId) {
563 self.id_to_set.insert(id, self.cur);
566 pub fn build_map(self) -> LintLevelMap {
567 LintLevelMap { sets: self.sets, id_to_set: self.id_to_set }
571 pub fn is_known_lint_tool(m_item: Symbol, sess: &Session, attrs: &[ast::Attribute]) -> bool {
572 if [sym::clippy, sym::rustc, sym::rustdoc].contains(&m_item) {
575 // Look for registered tools
576 // NOTE: does no error handling; error handling is done by rustc_resolve.
577 sess.filter_by_name(attrs, sym::register_tool)
578 .filter_map(|attr| attr.meta_item_list())
580 .filter_map(|nested_meta| nested_meta.ident())
581 .map(|ident| ident.name)
582 .any(|name| name == m_item)
585 struct LintLevelMapBuilder<'a, 'tcx> {
586 levels: LintLevelsBuilder<'tcx>,
588 store: &'a LintStore,
591 impl LintLevelMapBuilder<'_, '_> {
592 fn with_lint_attrs<F>(&mut self, id: hir::HirId, f: F)
594 F: FnOnce(&mut Self),
596 let is_crate_hir = id == hir::CRATE_HIR_ID;
597 let attrs = self.tcx.hir().attrs(id);
598 let push = self.levels.push(attrs, self.store, is_crate_hir);
600 self.levels.register_id(id);
603 self.levels.pop(push);
607 impl<'tcx> intravisit::Visitor<'tcx> for LintLevelMapBuilder<'_, 'tcx> {
608 type Map = Map<'tcx>;
610 fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<Self::Map> {
611 intravisit::NestedVisitorMap::All(self.tcx.hir())
614 fn visit_param(&mut self, param: &'tcx hir::Param<'tcx>) {
615 self.with_lint_attrs(param.hir_id, |builder| {
616 intravisit::walk_param(builder, param);
620 fn visit_item(&mut self, it: &'tcx hir::Item<'tcx>) {
621 self.with_lint_attrs(it.hir_id(), |builder| {
622 intravisit::walk_item(builder, it);
626 fn visit_foreign_item(&mut self, it: &'tcx hir::ForeignItem<'tcx>) {
627 self.with_lint_attrs(it.hir_id(), |builder| {
628 intravisit::walk_foreign_item(builder, it);
632 fn visit_stmt(&mut self, e: &'tcx hir::Stmt<'tcx>) {
633 // We will call `with_lint_attrs` when we walk
634 // the `StmtKind`. The outer statement itself doesn't
635 // define the lint levels.
636 intravisit::walk_stmt(self, e);
639 fn visit_expr(&mut self, e: &'tcx hir::Expr<'tcx>) {
640 self.with_lint_attrs(e.hir_id, |builder| {
641 intravisit::walk_expr(builder, e);
645 fn visit_field_def(&mut self, s: &'tcx hir::FieldDef<'tcx>) {
646 self.with_lint_attrs(s.hir_id, |builder| {
647 intravisit::walk_field_def(builder, s);
653 v: &'tcx hir::Variant<'tcx>,
654 g: &'tcx hir::Generics<'tcx>,
657 self.with_lint_attrs(v.id, |builder| {
658 intravisit::walk_variant(builder, v, g, item_id);
662 fn visit_local(&mut self, l: &'tcx hir::Local<'tcx>) {
663 self.with_lint_attrs(l.hir_id, |builder| {
664 intravisit::walk_local(builder, l);
668 fn visit_arm(&mut self, a: &'tcx hir::Arm<'tcx>) {
669 self.with_lint_attrs(a.hir_id, |builder| {
670 intravisit::walk_arm(builder, a);
674 fn visit_trait_item(&mut self, trait_item: &'tcx hir::TraitItem<'tcx>) {
675 self.with_lint_attrs(trait_item.hir_id(), |builder| {
676 intravisit::walk_trait_item(builder, trait_item);
680 fn visit_impl_item(&mut self, impl_item: &'tcx hir::ImplItem<'tcx>) {
681 self.with_lint_attrs(impl_item.hir_id(), |builder| {
682 intravisit::walk_impl_item(builder, impl_item);
687 pub fn provide(providers: &mut Providers) {
688 providers.lint_levels = lint_levels;