1 //! Contains utilities for generating suggestions for borrowck errors related to unsatisified
2 //! outlives constraints.
4 use std::collections::BTreeMap;
6 use rustc_data_structures::fx::FxHashSet;
7 use rustc_errors::DiagnosticBuilder;
8 use rustc_middle::ty::RegionVid;
11 use smallvec::SmallVec;
13 use crate::borrow_check::MirBorrowckCtxt;
15 use super::{ErrorConstraintInfo, RegionName, RegionNameSource};
17 /// The different things we could suggest.
18 enum SuggestedConstraint {
19 /// Outlives(a, [b, c, d, ...]) => 'a: 'b + 'c + 'd + ...
20 Outlives(RegionName, SmallVec<[RegionName; 2]>),
23 Equal(RegionName, RegionName),
25 /// 'a: 'static i.e. 'a = 'static and the user should just use 'static
29 /// Collects information about outlives constraints that needed to be added for a given MIR node
30 /// corresponding to a function definition.
32 /// Adds a help note suggesting adding a where clause with the needed constraints.
34 pub struct OutlivesSuggestionBuilder {
35 /// The list of outlives constraints that need to be added. Specifically, we map each free
36 /// region to all other regions that it must outlive. I will use the shorthand `fr:
37 /// outlived_frs`. Not all of these regions will already have names necessarily. Some could be
38 /// implicit free regions that we inferred. These will need to be given names in the final
39 /// suggestion message.
40 constraints_to_add: BTreeMap<RegionVid, Vec<RegionVid>>,
43 impl OutlivesSuggestionBuilder {
44 /// Returns `true` iff the `RegionNameSource` is a valid source for an outlives
47 // FIXME: Currently, we only report suggestions if the `RegionNameSource` is an early-bound
48 // region or a named region, avoiding using regions with synthetic names altogether. This
49 // allows us to avoid giving impossible suggestions (e.g. adding bounds to closure args).
50 // We can probably be less conservative, since some inferred free regions are namable (e.g.
51 // the user can explicitly name them. To do this, we would allow some regions whose names
52 // come from `MatchedAdtAndSegment`, being careful to filter out bad suggestions, such as
53 // naming the `'self` lifetime in methods, etc.
54 fn region_name_is_suggestable(name: &RegionName) -> bool {
56 RegionNameSource::NamedEarlyBoundRegion(..)
57 | RegionNameSource::NamedFreeRegion(..)
58 | RegionNameSource::Static => true,
60 // Don't give suggestions for upvars, closure return types, or other unnamable
62 RegionNameSource::SynthesizedFreeEnvRegion(..)
63 | RegionNameSource::AnonRegionFromArgument(..)
64 | RegionNameSource::AnonRegionFromUpvar(..)
65 | RegionNameSource::AnonRegionFromOutput(..)
66 | RegionNameSource::AnonRegionFromYieldTy(..)
67 | RegionNameSource::AnonRegionFromAsyncFn(..) => {
68 debug!("Region {:?} is NOT suggestable", name);
74 /// Returns a name for the region if it is suggestable. See `region_name_is_suggestable`.
75 fn region_vid_to_name(
77 mbcx: &MirBorrowckCtxt<'_, '_>,
79 ) -> Option<RegionName> {
80 mbcx.give_region_a_name(region).filter(Self::region_name_is_suggestable)
83 /// Compiles a list of all suggestions to be printed in the final big suggestion.
84 fn compile_all_suggestions(
86 mbcx: &MirBorrowckCtxt<'_, '_>,
87 ) -> SmallVec<[SuggestedConstraint; 2]> {
88 let mut suggested = SmallVec::new();
90 // Keep track of variables that we have already suggested unifying so that we don't print
91 // out silly duplicate messages.
92 let mut unified_already = FxHashSet::default();
94 for (fr, outlived) in &self.constraints_to_add {
95 let fr_name = if let Some(fr_name) = self.region_vid_to_name(mbcx, *fr) {
101 let outlived = outlived
103 // if there is a `None`, we will just omit that constraint
104 .filter_map(|fr| self.region_vid_to_name(mbcx, *fr).map(|rname| (fr, rname)))
105 .collect::<Vec<_>>();
107 // No suggestable outlived lifetimes.
108 if outlived.is_empty() {
112 // There are three types of suggestions we can make:
113 // 1) Suggest a bound: 'a: 'b
114 // 2) Suggest replacing 'a with 'static. If any of `outlived` is `'static`, then we
115 // should just replace 'a with 'static.
116 // 3) Suggest unifying 'a with 'b if we have both 'a: 'b and 'b: 'a
120 .any(|(_, outlived_name)| matches!(outlived_name.source, RegionNameSource::Static))
122 suggested.push(SuggestedConstraint::Static(fr_name));
124 // We want to isolate out all lifetimes that should be unified and print out
125 // separate messages for them.
127 let (unified, other): (Vec<_>, Vec<_>) = outlived.into_iter().partition(
128 // Do we have both 'fr: 'r and 'r: 'fr?
130 self.constraints_to_add
132 .map(|r_outlived| r_outlived.as_slice().contains(fr))
137 for (r, bound) in unified.into_iter() {
138 if !unified_already.contains(fr) {
139 suggested.push(SuggestedConstraint::Equal(fr_name.clone(), bound));
140 unified_already.insert(r);
144 if !other.is_empty() {
146 other.iter().map(|(_, rname)| rname.clone()).collect::<SmallVec<_>>();
147 suggested.push(SuggestedConstraint::Outlives(fr_name, other))
155 /// Add the outlives constraint `fr: outlived_fr` to the set of constraints we need to suggest.
156 crate fn collect_constraint(&mut self, fr: RegionVid, outlived_fr: RegionVid) {
157 debug!("Collected {:?}: {:?}", fr, outlived_fr);
159 // Add to set of constraints for final help note.
160 self.constraints_to_add.entry(fr).or_insert(Vec::new()).push(outlived_fr);
163 /// Emit an intermediate note on the given `Diagnostic` if the involved regions are
165 crate fn intermediate_suggestion(
167 mbcx: &MirBorrowckCtxt<'_, '_>,
168 errci: &ErrorConstraintInfo,
169 diag: &mut DiagnosticBuilder<'_>,
171 // Emit an intermediate note.
172 let fr_name = self.region_vid_to_name(mbcx, errci.fr);
173 let outlived_fr_name = self.region_vid_to_name(mbcx, errci.outlived_fr);
175 if let (Some(fr_name), Some(outlived_fr_name)) = (fr_name, outlived_fr_name) {
176 if let RegionNameSource::Static = outlived_fr_name.source {
177 diag.help(&format!("consider replacing `{}` with `'static`", fr_name));
180 "consider adding the following bound: `{}: {}`",
181 fr_name, outlived_fr_name
187 /// If there is a suggestion to emit, add a diagnostic to the buffer. This is the final
188 /// suggestion including all collected constraints.
189 crate fn add_suggestion(&self, mbcx: &mut MirBorrowckCtxt<'_, '_>) {
190 // No constraints to add? Done.
191 if self.constraints_to_add.is_empty() {
192 debug!("No constraints to suggest.");
196 // If there is only one constraint to suggest, then we already suggested it in the
197 // intermediate suggestion above.
198 if self.constraints_to_add.len() == 1
199 && self.constraints_to_add.values().next().unwrap().len() == 1
201 debug!("Only 1 suggestion. Skipping.");
205 // Get all suggestable constraints.
206 let suggested = self.compile_all_suggestions(mbcx);
208 // If there are no suggestable constraints...
209 if suggested.is_empty() {
210 debug!("Only 1 suggestable constraint. Skipping.");
214 // If there is exactly one suggestable constraints, then just suggest it. Otherwise, emit a
215 // list of diagnostics.
216 let mut diag = if suggested.len() == 1 {
217 mbcx.infcx.tcx.sess.diagnostic().struct_help(&match suggested.last().unwrap() {
218 SuggestedConstraint::Outlives(a, bs) => {
219 let bs: SmallVec<[String; 2]> = bs.iter().map(|r| format!("{}", r)).collect();
220 format!("add bound `{}: {}`", a, bs.join(" + "))
223 SuggestedConstraint::Equal(a, b) => {
224 format!("`{}` and `{}` must be the same: replace one with the other", a, b)
226 SuggestedConstraint::Static(a) => format!("replace `{}` with `'static`", a),
229 // Create a new diagnostic.
235 .struct_help("the following changes may resolve your lifetime errors");
238 for constraint in suggested {
240 SuggestedConstraint::Outlives(a, bs) => {
241 let bs: SmallVec<[String; 2]> =
242 bs.iter().map(|r| format!("{}", r)).collect();
243 diag.help(&format!("add bound `{}: {}`", a, bs.join(" + ")));
245 SuggestedConstraint::Equal(a, b) => {
247 "`{}` and `{}` must be the same: replace one with the other",
251 SuggestedConstraint::Static(a) => {
252 diag.help(&format!("replace `{}` with `'static`", a));
260 // We want this message to appear after other messages on the mir def.
261 let mir_span = mbcx.body.span;
262 diag.sort_span = mir_span.shrink_to_hi();
264 // Buffer the diagnostic
265 diag.buffer(&mut mbcx.errors_buffer);