Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Only invoke decorate if the diag can eventually be emitted #122578

Merged
merged 3 commits into from
Mar 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions compiler/rustc_middle/src/lint.rs
Original file line number Diff line number Diff line change
Expand Up @@ -398,8 +398,22 @@ pub fn lint_level(
}
}

// Finally, run `decorate`.
decorate(&mut err);
// Finally, run `decorate`. `decorate` can call `trimmed_path_str` (directly or indirectly),
// so we need to make sure when we do call `decorate` that the diagnostic is eventually
// emitted or we'll get a `must_produce_diag` ICE.
//
// When is a diagnostic *eventually* emitted? Well, that is determined by 2 factors:
// 1. If the corresponding `rustc_errors::Level` is beyond warning, i.e. `ForceWarning(_)`
// or `Error`, then the diagnostic will be emitted regardless of CLI options.
// 2. If the corresponding `rustc_errors::Level` is warning, then that can be affected by
// `-A warnings` or `--cap-lints=xxx` on the command line. In which case, the diagnostic
// will be emitted if `can_emit_warnings` is true.
let skip = err_level == rustc_errors::Level::Warning && !sess.dcx().can_emit_warnings();

if !skip {
decorate(&mut err);
}

explain_lint_level_source(lint, level, src, &mut err);
err.emit()
}
Expand Down
11 changes: 11 additions & 0 deletions tests/ui/lint/decorate-ice/decorate-can-emit-warnings.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
// Checks that the following does not ICE because `decorate` is incorrectly skipped.

//@ compile-flags: -Dunused_must_use -Awarnings --crate-type=lib

#[must_use]
fn f() {}

pub fn g() {
f();
//~^ ERROR unused return value
}
14 changes: 14 additions & 0 deletions tests/ui/lint/decorate-ice/decorate-can-emit-warnings.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
error: unused return value of `f` that must be used
--> $DIR/decorate-can-emit-warnings.rs:9:5
|
LL | f();
| ^^^
|
= note: requested on the command line with `-D unused-must-use`
help: use `let _ = ...` to ignore the resulting value
|
LL | let _ = f();
| +++++++

error: aborting due to 1 previous error

30 changes: 30 additions & 0 deletions tests/ui/lint/decorate-ice/decorate-def-path-str-ice.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// Checks that the following does not ICE.
//
// Previously, this test ICEs when the `unused_must_use` lint is suppressed via the combination of
// `-A warnings` and `--cap-lints=warn`, because:
//
// - Its lint diagnostic struct `UnusedDef` implements `LintDiagnostic` manually and in the impl
// `def_path_str` was called (which calls `trimmed_def_path`, which will produce a
// `must_produce_diag` ICE if a trimmed def path is constructed but never emitted in a diagnostic
// because it is expensive to compute).
// - A `LintDiagnostic` has a `decorate_lint` method which decorates a `Diag` with lint-specific
// information. This method is wrapped by a `decorate` closure in `TyCtxt` diagnostic emission
// machinery, and the `decorate` closure called as late as possible.
// - `decorate`'s invocation is delayed as late as possible until `lint_level` is called.
// - If a lint's corresponding diagnostic is suppressed (to be effectively allow at the final
// emission time) via `-A warnings` or `--cap-lints=allow` (or `-A warnings` + `--cap-lints=warn`
// like in this test case), `decorate` is still called and a diagnostic is still constructed --
// but the diagnostic is never eventually emitted, triggering the aforementioned
// `must_produce_diag` ICE due to use of `trimmed_def_path`.
//
// Issue: <https://github.com/rust-lang/rust/issues/121774>.

//@ compile-flags: -Dunused_must_use -Awarnings --cap-lints=warn --crate-type=lib
//@ check-pass

#[must_use]
fn f() {}

pub fn g() {
f();
}
13 changes: 13 additions & 0 deletions tests/ui/lint/decorate-ice/decorate-force-warn.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// Checks that the following does not ICE because `decorate` is incorrectly skipped due to
// `--force-warn`.

//@ compile-flags: -Dunused_must_use -Awarnings --force-warn unused_must_use --crate-type=lib
//@ check-pass

#[must_use]
fn f() {}

pub fn g() {
f();
//~^ WARN unused return value
}
14 changes: 14 additions & 0 deletions tests/ui/lint/decorate-ice/decorate-force-warn.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
warning: unused return value of `f` that must be used
--> $DIR/decorate-force-warn.rs:11:5
|
LL | f();
| ^^^
|
= note: requested on the command line with `--force-warn unused-must-use`
help: use `let _ = ...` to ignore the resulting value
|
LL | let _ = f();
| +++++++

warning: 1 warning emitted

Loading