]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_hir_typeck/src/coercion.rs
Simplify creation of `AutoBorrowMutability`
[rust.git] / compiler / rustc_hir_typeck / src / coercion.rs
1 //! # Type Coercion
2 //!
3 //! Under certain circumstances we will coerce from one type to another,
4 //! for example by auto-borrowing. This occurs in situations where the
5 //! compiler has a firm 'expected type' that was supplied from the user,
6 //! and where the actual type is similar to that expected type in purpose
7 //! but not in representation (so actual subtyping is inappropriate).
8 //!
9 //! ## Reborrowing
10 //!
11 //! Note that if we are expecting a reference, we will *reborrow*
12 //! even if the argument provided was already a reference. This is
13 //! useful for freezing mut things (that is, when the expected type is &T
14 //! but you have &mut T) and also for avoiding the linearity
15 //! of mut things (when the expected is &mut T and you have &mut T). See
16 //! the various `src/test/ui/coerce/*.rs` tests for
17 //! examples of where this is useful.
18 //!
19 //! ## Subtle note
20 //!
21 //! When inferring the generic arguments of functions, the argument
22 //! order is relevant, which can lead to the following edge case:
23 //!
24 //! ```ignore (illustrative)
25 //! fn foo<T>(a: T, b: T) {
26 //!     // ...
27 //! }
28 //!
29 //! foo(&7i32, &mut 7i32);
30 //! // This compiles, as we first infer `T` to be `&i32`,
31 //! // and then coerce `&mut 7i32` to `&7i32`.
32 //!
33 //! foo(&mut 7i32, &7i32);
34 //! // This does not compile, as we first infer `T` to be `&mut i32`
35 //! // and are then unable to coerce `&7i32` to `&mut i32`.
36 //! ```
37
38 use crate::FnCtxt;
39 use rustc_errors::{
40     struct_span_err, Applicability, Diagnostic, DiagnosticBuilder, ErrorGuaranteed, MultiSpan,
41 };
42 use rustc_hir as hir;
43 use rustc_hir::def_id::DefId;
44 use rustc_hir::intravisit::{self, Visitor};
45 use rustc_hir::Expr;
46 use rustc_hir_analysis::astconv::AstConv;
47 use rustc_infer::infer::type_variable::{TypeVariableOrigin, TypeVariableOriginKind};
48 use rustc_infer::infer::{Coercion, InferOk, InferResult};
49 use rustc_infer::traits::Obligation;
50 use rustc_middle::lint::in_external_macro;
51 use rustc_middle::ty::adjustment::{
52     Adjust, Adjustment, AllowTwoPhase, AutoBorrow, AutoBorrowMutability, PointerCast,
53 };
54 use rustc_middle::ty::error::TypeError;
55 use rustc_middle::ty::relate::RelateResult;
56 use rustc_middle::ty::subst::SubstsRef;
57 use rustc_middle::ty::visit::TypeVisitable;
58 use rustc_middle::ty::{self, Ty, TypeAndMut};
59 use rustc_session::parse::feature_err;
60 use rustc_span::symbol::sym;
61 use rustc_span::{self, BytePos, DesugaringKind, Span};
62 use rustc_target::spec::abi::Abi;
63 use rustc_trait_selection::infer::InferCtxtExt as _;
64 use rustc_trait_selection::traits::error_reporting::TypeErrCtxtExt as _;
65 use rustc_trait_selection::traits::{self, ObligationCause, ObligationCauseCode, ObligationCtxt};
66
67 use smallvec::{smallvec, SmallVec};
68 use std::ops::Deref;
69
70 struct Coerce<'a, 'tcx> {
71     fcx: &'a FnCtxt<'a, 'tcx>,
72     cause: ObligationCause<'tcx>,
73     use_lub: bool,
74     /// Determines whether or not allow_two_phase_borrow is set on any
75     /// autoref adjustments we create while coercing. We don't want to
76     /// allow deref coercions to create two-phase borrows, at least initially,
77     /// but we do need two-phase borrows for function argument reborrows.
78     /// See #47489 and #48598
79     /// See docs on the "AllowTwoPhase" type for a more detailed discussion
80     allow_two_phase: AllowTwoPhase,
81 }
82
83 impl<'a, 'tcx> Deref for Coerce<'a, 'tcx> {
84     type Target = FnCtxt<'a, 'tcx>;
85     fn deref(&self) -> &Self::Target {
86         &self.fcx
87     }
88 }
89
90 type CoerceResult<'tcx> = InferResult<'tcx, (Vec<Adjustment<'tcx>>, Ty<'tcx>)>;
91
92 struct CollectRetsVisitor<'tcx> {
93     ret_exprs: Vec<&'tcx hir::Expr<'tcx>>,
94 }
95
96 impl<'tcx> Visitor<'tcx> for CollectRetsVisitor<'tcx> {
97     fn visit_expr(&mut self, expr: &'tcx Expr<'tcx>) {
98         if let hir::ExprKind::Ret(_) = expr.kind {
99             self.ret_exprs.push(expr);
100         }
101         intravisit::walk_expr(self, expr);
102     }
103 }
104
105 /// Coercing a mutable reference to an immutable works, while
106 /// coercing `&T` to `&mut T` should be forbidden.
107 fn coerce_mutbls<'tcx>(
108     from_mutbl: hir::Mutability,
109     to_mutbl: hir::Mutability,
110 ) -> RelateResult<'tcx, ()> {
111     if from_mutbl >= to_mutbl { Ok(()) } else { Err(TypeError::Mutability) }
112 }
113
114 /// Do not require any adjustments, i.e. coerce `x -> x`.
115 fn identity(_: Ty<'_>) -> Vec<Adjustment<'_>> {
116     vec![]
117 }
118
119 fn simple<'tcx>(kind: Adjust<'tcx>) -> impl FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>> {
120     move |target| vec![Adjustment { kind, target }]
121 }
122
123 /// This always returns `Ok(...)`.
124 fn success<'tcx>(
125     adj: Vec<Adjustment<'tcx>>,
126     target: Ty<'tcx>,
127     obligations: traits::PredicateObligations<'tcx>,
128 ) -> CoerceResult<'tcx> {
129     Ok(InferOk { value: (adj, target), obligations })
130 }
131
132 impl<'f, 'tcx> Coerce<'f, 'tcx> {
133     fn new(
134         fcx: &'f FnCtxt<'f, 'tcx>,
135         cause: ObligationCause<'tcx>,
136         allow_two_phase: AllowTwoPhase,
137     ) -> Self {
138         Coerce { fcx, cause, allow_two_phase, use_lub: false }
139     }
140
141     fn unify(&self, a: Ty<'tcx>, b: Ty<'tcx>) -> InferResult<'tcx, Ty<'tcx>> {
142         debug!("unify(a: {:?}, b: {:?}, use_lub: {})", a, b, self.use_lub);
143         self.commit_if_ok(|_| {
144             if self.use_lub {
145                 self.at(&self.cause, self.fcx.param_env).lub(b, a)
146             } else {
147                 self.at(&self.cause, self.fcx.param_env)
148                     .sup(b, a)
149                     .map(|InferOk { value: (), obligations }| InferOk { value: a, obligations })
150             }
151         })
152     }
153
154     /// Unify two types (using sub or lub) and produce a specific coercion.
155     fn unify_and<F>(&self, a: Ty<'tcx>, b: Ty<'tcx>, f: F) -> CoerceResult<'tcx>
156     where
157         F: FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
158     {
159         self.unify(a, b)
160             .and_then(|InferOk { value: ty, obligations }| success(f(ty), ty, obligations))
161     }
162
163     #[instrument(skip(self))]
164     fn coerce(&self, a: Ty<'tcx>, b: Ty<'tcx>) -> CoerceResult<'tcx> {
165         // First, remove any resolved type variables (at the top level, at least):
166         let a = self.shallow_resolve(a);
167         let b = self.shallow_resolve(b);
168         debug!("Coerce.tys({:?} => {:?})", a, b);
169
170         // Just ignore error types.
171         if a.references_error() || b.references_error() {
172             return success(vec![], self.fcx.tcx.ty_error(), vec![]);
173         }
174
175         // Coercing from `!` to any type is allowed:
176         if a.is_never() {
177             return success(simple(Adjust::NeverToAny)(b), b, vec![]);
178         }
179
180         // Coercing *from* an unresolved inference variable means that
181         // we have no information about the source type. This will always
182         // ultimately fall back to some form of subtyping.
183         if a.is_ty_var() {
184             return self.coerce_from_inference_variable(a, b, identity);
185         }
186
187         // Consider coercing the subtype to a DST
188         //
189         // NOTE: this is wrapped in a `commit_if_ok` because it creates
190         // a "spurious" type variable, and we don't want to have that
191         // type variable in memory if the coercion fails.
192         let unsize = self.commit_if_ok(|_| self.coerce_unsized(a, b));
193         match unsize {
194             Ok(_) => {
195                 debug!("coerce: unsize successful");
196                 return unsize;
197             }
198             Err(TypeError::ObjectUnsafeCoercion(did)) => {
199                 debug!("coerce: unsize not object safe");
200                 return Err(TypeError::ObjectUnsafeCoercion(did));
201             }
202             Err(error) => {
203                 debug!(?error, "coerce: unsize failed");
204             }
205         }
206
207         // Examine the supertype and consider auto-borrowing.
208         match *b.kind() {
209             ty::RawPtr(mt_b) => {
210                 return self.coerce_unsafe_ptr(a, b, mt_b.mutbl);
211             }
212             ty::Ref(r_b, _, mutbl_b) => {
213                 return self.coerce_borrowed_pointer(a, b, r_b, mutbl_b);
214             }
215             ty::Dynamic(predicates, region, ty::DynStar) if self.tcx.features().dyn_star => {
216                 return self.coerce_dyn_star(a, b, predicates, region);
217             }
218             _ => {}
219         }
220
221         match *a.kind() {
222             ty::FnDef(..) => {
223                 // Function items are coercible to any closure
224                 // type; function pointers are not (that would
225                 // require double indirection).
226                 // Additionally, we permit coercion of function
227                 // items to drop the unsafe qualifier.
228                 self.coerce_from_fn_item(a, b)
229             }
230             ty::FnPtr(a_f) => {
231                 // We permit coercion of fn pointers to drop the
232                 // unsafe qualifier.
233                 self.coerce_from_fn_pointer(a, a_f, b)
234             }
235             ty::Closure(closure_def_id_a, substs_a) => {
236                 // Non-capturing closures are coercible to
237                 // function pointers or unsafe function pointers.
238                 // It cannot convert closures that require unsafe.
239                 self.coerce_closure_to_fn(a, closure_def_id_a, substs_a, b)
240             }
241             _ => {
242                 // Otherwise, just use unification rules.
243                 self.unify_and(a, b, identity)
244             }
245         }
246     }
247
248     /// Coercing *from* an inference variable. In this case, we have no information
249     /// about the source type, so we can't really do a true coercion and we always
250     /// fall back to subtyping (`unify_and`).
251     fn coerce_from_inference_variable(
252         &self,
253         a: Ty<'tcx>,
254         b: Ty<'tcx>,
255         make_adjustments: impl FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
256     ) -> CoerceResult<'tcx> {
257         debug!("coerce_from_inference_variable(a={:?}, b={:?})", a, b);
258         assert!(a.is_ty_var() && self.shallow_resolve(a) == a);
259         assert!(self.shallow_resolve(b) == b);
260
261         if b.is_ty_var() {
262             // Two unresolved type variables: create a `Coerce` predicate.
263             let target_ty = if self.use_lub {
264                 self.next_ty_var(TypeVariableOrigin {
265                     kind: TypeVariableOriginKind::LatticeVariable,
266                     span: self.cause.span,
267                 })
268             } else {
269                 b
270             };
271
272             let mut obligations = Vec::with_capacity(2);
273             for &source_ty in &[a, b] {
274                 if source_ty != target_ty {
275                     obligations.push(Obligation::new(
276                         self.tcx(),
277                         self.cause.clone(),
278                         self.param_env,
279                         ty::Binder::dummy(ty::PredicateKind::Coerce(ty::CoercePredicate {
280                             a: source_ty,
281                             b: target_ty,
282                         })),
283                     ));
284                 }
285             }
286
287             debug!(
288                 "coerce_from_inference_variable: two inference variables, target_ty={:?}, obligations={:?}",
289                 target_ty, obligations
290             );
291             let adjustments = make_adjustments(target_ty);
292             InferResult::Ok(InferOk { value: (adjustments, target_ty), obligations })
293         } else {
294             // One unresolved type variable: just apply subtyping, we may be able
295             // to do something useful.
296             self.unify_and(a, b, make_adjustments)
297         }
298     }
299
300     /// Reborrows `&mut A` to `&mut B` and `&(mut) A` to `&B`.
301     /// To match `A` with `B`, autoderef will be performed,
302     /// calling `deref`/`deref_mut` where necessary.
303     fn coerce_borrowed_pointer(
304         &self,
305         a: Ty<'tcx>,
306         b: Ty<'tcx>,
307         r_b: ty::Region<'tcx>,
308         mutbl_b: hir::Mutability,
309     ) -> CoerceResult<'tcx> {
310         debug!("coerce_borrowed_pointer(a={:?}, b={:?})", a, b);
311
312         // If we have a parameter of type `&M T_a` and the value
313         // provided is `expr`, we will be adding an implicit borrow,
314         // meaning that we convert `f(expr)` to `f(&M *expr)`.  Therefore,
315         // to type check, we will construct the type that `&M*expr` would
316         // yield.
317
318         let (r_a, mt_a) = match *a.kind() {
319             ty::Ref(r_a, ty, mutbl) => {
320                 let mt_a = ty::TypeAndMut { ty, mutbl };
321                 coerce_mutbls(mt_a.mutbl, mutbl_b)?;
322                 (r_a, mt_a)
323             }
324             _ => return self.unify_and(a, b, identity),
325         };
326
327         let span = self.cause.span;
328
329         let mut first_error = None;
330         let mut r_borrow_var = None;
331         let mut autoderef = self.autoderef(span, a);
332         let mut found = None;
333
334         for (referent_ty, autoderefs) in autoderef.by_ref() {
335             if autoderefs == 0 {
336                 // Don't let this pass, otherwise it would cause
337                 // &T to autoref to &&T.
338                 continue;
339             }
340
341             // At this point, we have deref'd `a` to `referent_ty`.  So
342             // imagine we are coercing from `&'a mut Vec<T>` to `&'b mut [T]`.
343             // In the autoderef loop for `&'a mut Vec<T>`, we would get
344             // three callbacks:
345             //
346             // - `&'a mut Vec<T>` -- 0 derefs, just ignore it
347             // - `Vec<T>` -- 1 deref
348             // - `[T]` -- 2 deref
349             //
350             // At each point after the first callback, we want to
351             // check to see whether this would match out target type
352             // (`&'b mut [T]`) if we autoref'd it. We can't just
353             // compare the referent types, though, because we still
354             // have to consider the mutability. E.g., in the case
355             // we've been considering, we have an `&mut` reference, so
356             // the `T` in `[T]` needs to be unified with equality.
357             //
358             // Therefore, we construct reference types reflecting what
359             // the types will be after we do the final auto-ref and
360             // compare those. Note that this means we use the target
361             // mutability [1], since it may be that we are coercing
362             // from `&mut T` to `&U`.
363             //
364             // One fine point concerns the region that we use. We
365             // choose the region such that the region of the final
366             // type that results from `unify` will be the region we
367             // want for the autoref:
368             //
369             // - if in sub mode, that means we want to use `'b` (the
370             //   region from the target reference) for both
371             //   pointers [2]. This is because sub mode (somewhat
372             //   arbitrarily) returns the subtype region.  In the case
373             //   where we are coercing to a target type, we know we
374             //   want to use that target type region (`'b`) because --
375             //   for the program to type-check -- it must be the
376             //   smaller of the two.
377             //   - One fine point. It may be surprising that we can
378             //     use `'b` without relating `'a` and `'b`. The reason
379             //     that this is ok is that what we produce is
380             //     effectively a `&'b *x` expression (if you could
381             //     annotate the region of a borrow), and regionck has
382             //     code that adds edges from the region of a borrow
383             //     (`'b`, here) into the regions in the borrowed
384             //     expression (`*x`, here).  (Search for "link".)
385             // - if in lub mode, things can get fairly complicated. The
386             //   easiest thing is just to make a fresh
387             //   region variable [4], which effectively means we defer
388             //   the decision to region inference (and regionck, which will add
389             //   some more edges to this variable). However, this can wind up
390             //   creating a crippling number of variables in some cases --
391             //   e.g., #32278 -- so we optimize one particular case [3].
392             //   Let me try to explain with some examples:
393             //   - The "running example" above represents the simple case,
394             //     where we have one `&` reference at the outer level and
395             //     ownership all the rest of the way down. In this case,
396             //     we want `LUB('a, 'b)` as the resulting region.
397             //   - However, if there are nested borrows, that region is
398             //     too strong. Consider a coercion from `&'a &'x Rc<T>` to
399             //     `&'b T`. In this case, `'a` is actually irrelevant.
400             //     The pointer we want is `LUB('x, 'b`). If we choose `LUB('a,'b)`
401             //     we get spurious errors (`ui/regions-lub-ref-ref-rc.rs`).
402             //     (The errors actually show up in borrowck, typically, because
403             //     this extra edge causes the region `'a` to be inferred to something
404             //     too big, which then results in borrowck errors.)
405             //   - We could track the innermost shared reference, but there is already
406             //     code in regionck that has the job of creating links between
407             //     the region of a borrow and the regions in the thing being
408             //     borrowed (here, `'a` and `'x`), and it knows how to handle
409             //     all the various cases. So instead we just make a region variable
410             //     and let regionck figure it out.
411             let r = if !self.use_lub {
412                 r_b // [2] above
413             } else if autoderefs == 1 {
414                 r_a // [3] above
415             } else {
416                 if r_borrow_var.is_none() {
417                     // create var lazily, at most once
418                     let coercion = Coercion(span);
419                     let r = self.next_region_var(coercion);
420                     r_borrow_var = Some(r); // [4] above
421                 }
422                 r_borrow_var.unwrap()
423             };
424             let derefd_ty_a = self.tcx.mk_ref(
425                 r,
426                 TypeAndMut {
427                     ty: referent_ty,
428                     mutbl: mutbl_b, // [1] above
429                 },
430             );
431             match self.unify(derefd_ty_a, b) {
432                 Ok(ok) => {
433                     found = Some(ok);
434                     break;
435                 }
436                 Err(err) => {
437                     if first_error.is_none() {
438                         first_error = Some(err);
439                     }
440                 }
441             }
442         }
443
444         // Extract type or return an error. We return the first error
445         // we got, which should be from relating the "base" type
446         // (e.g., in example above, the failure from relating `Vec<T>`
447         // to the target type), since that should be the least
448         // confusing.
449         let Some(InferOk { value: ty, mut obligations }) = found else {
450             let err = first_error.expect("coerce_borrowed_pointer had no error");
451             debug!("coerce_borrowed_pointer: failed with err = {:?}", err);
452             return Err(err);
453         };
454
455         if ty == a && mt_a.mutbl.is_not() && autoderef.step_count() == 1 {
456             // As a special case, if we would produce `&'a *x`, that's
457             // a total no-op. We end up with the type `&'a T` just as
458             // we started with.  In that case, just skip it
459             // altogether. This is just an optimization.
460             //
461             // Note that for `&mut`, we DO want to reborrow --
462             // otherwise, this would be a move, which might be an
463             // error. For example `foo(self.x)` where `self` and
464             // `self.x` both have `&mut `type would be a move of
465             // `self.x`, but we auto-coerce it to `foo(&mut *self.x)`,
466             // which is a borrow.
467             assert_eq!(mutbl_b, hir::Mutability::Not); // can only coerce &T -> &U
468             return success(vec![], ty, obligations);
469         }
470
471         let InferOk { value: mut adjustments, obligations: o } =
472             self.adjust_steps_as_infer_ok(&autoderef);
473         obligations.extend(o);
474         obligations.extend(autoderef.into_obligations());
475
476         // Now apply the autoref. We have to extract the region out of
477         // the final ref type we got.
478         let ty::Ref(r_borrow, _, _) = ty.kind() else {
479             span_bug!(span, "expected a ref type, got {:?}", ty);
480         };
481         let mutbl = AutoBorrowMutability::new(mutbl_b, self.allow_two_phase);
482         adjustments.push(Adjustment {
483             kind: Adjust::Borrow(AutoBorrow::Ref(*r_borrow, mutbl)),
484             target: ty,
485         });
486
487         debug!("coerce_borrowed_pointer: succeeded ty={:?} adjustments={:?}", ty, adjustments);
488
489         success(adjustments, ty, obligations)
490     }
491
492     // &[T; n] or &mut [T; n] -> &[T]
493     // or &mut [T; n] -> &mut [T]
494     // or &Concrete -> &Trait, etc.
495     #[instrument(skip(self), level = "debug")]
496     fn coerce_unsized(&self, mut source: Ty<'tcx>, mut target: Ty<'tcx>) -> CoerceResult<'tcx> {
497         source = self.shallow_resolve(source);
498         target = self.shallow_resolve(target);
499         debug!(?source, ?target);
500
501         // These 'if' statements require some explanation.
502         // The `CoerceUnsized` trait is special - it is only
503         // possible to write `impl CoerceUnsized<B> for A` where
504         // A and B have 'matching' fields. This rules out the following
505         // two types of blanket impls:
506         //
507         // `impl<T> CoerceUnsized<T> for SomeType`
508         // `impl<T> CoerceUnsized<SomeType> for T`
509         //
510         // Both of these trigger a special `CoerceUnsized`-related error (E0376)
511         //
512         // We can take advantage of this fact to avoid performing unnecessary work.
513         // If either `source` or `target` is a type variable, then any applicable impl
514         // would need to be generic over the self-type (`impl<T> CoerceUnsized<SomeType> for T`)
515         // or generic over the `CoerceUnsized` type parameter (`impl<T> CoerceUnsized<T> for
516         // SomeType`).
517         //
518         // However, these are exactly the kinds of impls which are forbidden by
519         // the compiler! Therefore, we can be sure that coercion will always fail
520         // when either the source or target type is a type variable. This allows us
521         // to skip performing any trait selection, and immediately bail out.
522         if source.is_ty_var() {
523             debug!("coerce_unsized: source is a TyVar, bailing out");
524             return Err(TypeError::Mismatch);
525         }
526         if target.is_ty_var() {
527             debug!("coerce_unsized: target is a TyVar, bailing out");
528             return Err(TypeError::Mismatch);
529         }
530
531         let traits =
532             (self.tcx.lang_items().unsize_trait(), self.tcx.lang_items().coerce_unsized_trait());
533         let (Some(unsize_did), Some(coerce_unsized_did)) = traits else {
534             debug!("missing Unsize or CoerceUnsized traits");
535             return Err(TypeError::Mismatch);
536         };
537
538         // Note, we want to avoid unnecessary unsizing. We don't want to coerce to
539         // a DST unless we have to. This currently comes out in the wash since
540         // we can't unify [T] with U. But to properly support DST, we need to allow
541         // that, at which point we will need extra checks on the target here.
542
543         // Handle reborrows before selecting `Source: CoerceUnsized<Target>`.
544         let reborrow = match (source.kind(), target.kind()) {
545             (&ty::Ref(_, ty_a, mutbl_a), &ty::Ref(_, _, mutbl_b)) => {
546                 coerce_mutbls(mutbl_a, mutbl_b)?;
547
548                 let coercion = Coercion(self.cause.span);
549                 let r_borrow = self.next_region_var(coercion);
550
551                 // We don't allow two-phase borrows here, at least for initial
552                 // implementation. If it happens that this coercion is a function argument,
553                 // the reborrow in coerce_borrowed_ptr will pick it up.
554                 let mutbl = AutoBorrowMutability::new(mutbl_b, AllowTwoPhase::No);
555
556                 Some((
557                     Adjustment { kind: Adjust::Deref(None), target: ty_a },
558                     Adjustment {
559                         kind: Adjust::Borrow(AutoBorrow::Ref(r_borrow, mutbl)),
560                         target: self
561                             .tcx
562                             .mk_ref(r_borrow, ty::TypeAndMut { mutbl: mutbl_b, ty: ty_a }),
563                     },
564                 ))
565             }
566             (&ty::Ref(_, ty_a, mt_a), &ty::RawPtr(ty::TypeAndMut { mutbl: mt_b, .. })) => {
567                 coerce_mutbls(mt_a, mt_b)?;
568
569                 Some((
570                     Adjustment { kind: Adjust::Deref(None), target: ty_a },
571                     Adjustment {
572                         kind: Adjust::Borrow(AutoBorrow::RawPtr(mt_b)),
573                         target: self.tcx.mk_ptr(ty::TypeAndMut { mutbl: mt_b, ty: ty_a }),
574                     },
575                 ))
576             }
577             _ => None,
578         };
579         let coerce_source = reborrow.as_ref().map_or(source, |&(_, ref r)| r.target);
580
581         // Setup either a subtyping or a LUB relationship between
582         // the `CoerceUnsized` target type and the expected type.
583         // We only have the latter, so we use an inference variable
584         // for the former and let type inference do the rest.
585         let origin = TypeVariableOrigin {
586             kind: TypeVariableOriginKind::MiscVariable,
587             span: self.cause.span,
588         };
589         let coerce_target = self.next_ty_var(origin);
590         let mut coercion = self.unify_and(coerce_target, target, |target| {
591             let unsize = Adjustment { kind: Adjust::Pointer(PointerCast::Unsize), target };
592             match reborrow {
593                 None => vec![unsize],
594                 Some((ref deref, ref autoref)) => vec![deref.clone(), autoref.clone(), unsize],
595             }
596         })?;
597
598         let mut selcx = traits::SelectionContext::new(self);
599
600         // Create an obligation for `Source: CoerceUnsized<Target>`.
601         let cause = ObligationCause::new(
602             self.cause.span,
603             self.body_id,
604             ObligationCauseCode::Coercion { source, target },
605         );
606
607         // Use a FIFO queue for this custom fulfillment procedure.
608         //
609         // A Vec (or SmallVec) is not a natural choice for a queue. However,
610         // this code path is hot, and this queue usually has a max length of 1
611         // and almost never more than 3. By using a SmallVec we avoid an
612         // allocation, at the (very small) cost of (occasionally) having to
613         // shift subsequent elements down when removing the front element.
614         let mut queue: SmallVec<[_; 4]> = smallvec![traits::predicate_for_trait_def(
615             self.tcx,
616             self.fcx.param_env,
617             cause,
618             coerce_unsized_did,
619             0,
620             [coerce_source, coerce_target]
621         )];
622
623         let mut has_unsized_tuple_coercion = false;
624         let mut has_trait_upcasting_coercion = None;
625
626         // Keep resolving `CoerceUnsized` and `Unsize` predicates to avoid
627         // emitting a coercion in cases like `Foo<$1>` -> `Foo<$2>`, where
628         // inference might unify those two inner type variables later.
629         let traits = [coerce_unsized_did, unsize_did];
630         while !queue.is_empty() {
631             let obligation = queue.remove(0);
632             debug!("coerce_unsized resolve step: {:?}", obligation);
633             let bound_predicate = obligation.predicate.kind();
634             let trait_pred = match bound_predicate.skip_binder() {
635                 ty::PredicateKind::Trait(trait_pred) if traits.contains(&trait_pred.def_id()) => {
636                     if unsize_did == trait_pred.def_id() {
637                         let self_ty = trait_pred.self_ty();
638                         let unsize_ty = trait_pred.trait_ref.substs[1].expect_ty();
639                         if let (ty::Dynamic(ref data_a, ..), ty::Dynamic(ref data_b, ..)) =
640                             (self_ty.kind(), unsize_ty.kind())
641                             && data_a.principal_def_id() != data_b.principal_def_id()
642                         {
643                             debug!("coerce_unsized: found trait upcasting coercion");
644                             has_trait_upcasting_coercion = Some((self_ty, unsize_ty));
645                         }
646                         if let ty::Tuple(..) = unsize_ty.kind() {
647                             debug!("coerce_unsized: found unsized tuple coercion");
648                             has_unsized_tuple_coercion = true;
649                         }
650                     }
651                     bound_predicate.rebind(trait_pred)
652                 }
653                 _ => {
654                     coercion.obligations.push(obligation);
655                     continue;
656                 }
657             };
658             match selcx.select(&obligation.with(selcx.tcx(), trait_pred)) {
659                 // Uncertain or unimplemented.
660                 Ok(None) => {
661                     if trait_pred.def_id() == unsize_did {
662                         let trait_pred = self.resolve_vars_if_possible(trait_pred);
663                         let self_ty = trait_pred.skip_binder().self_ty();
664                         let unsize_ty = trait_pred.skip_binder().trait_ref.substs[1].expect_ty();
665                         debug!("coerce_unsized: ambiguous unsize case for {:?}", trait_pred);
666                         match (&self_ty.kind(), &unsize_ty.kind()) {
667                             (ty::Infer(ty::TyVar(v)), ty::Dynamic(..))
668                                 if self.type_var_is_sized(*v) =>
669                             {
670                                 debug!("coerce_unsized: have sized infer {:?}", v);
671                                 coercion.obligations.push(obligation);
672                                 // `$0: Unsize<dyn Trait>` where we know that `$0: Sized`, try going
673                                 // for unsizing.
674                             }
675                             _ => {
676                                 // Some other case for `$0: Unsize<Something>`. Note that we
677                                 // hit this case even if `Something` is a sized type, so just
678                                 // don't do the coercion.
679                                 debug!("coerce_unsized: ambiguous unsize");
680                                 return Err(TypeError::Mismatch);
681                             }
682                         }
683                     } else {
684                         debug!("coerce_unsized: early return - ambiguous");
685                         return Err(TypeError::Mismatch);
686                     }
687                 }
688                 Err(traits::Unimplemented) => {
689                     debug!("coerce_unsized: early return - can't prove obligation");
690                     return Err(TypeError::Mismatch);
691                 }
692
693                 // Object safety violations or miscellaneous.
694                 Err(err) => {
695                     self.err_ctxt().report_selection_error(obligation.clone(), &obligation, &err);
696                     // Treat this like an obligation and follow through
697                     // with the unsizing - the lack of a coercion should
698                     // be silent, as it causes a type mismatch later.
699                 }
700
701                 Ok(Some(impl_source)) => queue.extend(impl_source.nested_obligations()),
702             }
703         }
704
705         if has_unsized_tuple_coercion && !self.tcx.features().unsized_tuple_coercion {
706             feature_err(
707                 &self.tcx.sess.parse_sess,
708                 sym::unsized_tuple_coercion,
709                 self.cause.span,
710                 "unsized tuple coercion is not stable enough for use and is subject to change",
711             )
712             .emit();
713         }
714
715         if let Some((sub, sup)) = has_trait_upcasting_coercion
716             && !self.tcx().features().trait_upcasting
717         {
718             // Renders better when we erase regions, since they're not really the point here.
719             let (sub, sup) = self.tcx.erase_regions((sub, sup));
720             let mut err = feature_err(
721                 &self.tcx.sess.parse_sess,
722                 sym::trait_upcasting,
723                 self.cause.span,
724                 &format!("cannot cast `{sub}` to `{sup}`, trait upcasting coercion is experimental"),
725             );
726             err.note(&format!("required when coercing `{source}` into `{target}`"));
727             err.emit();
728         }
729
730         Ok(coercion)
731     }
732
733     fn coerce_dyn_star(
734         &self,
735         a: Ty<'tcx>,
736         b: Ty<'tcx>,
737         predicates: &'tcx ty::List<ty::PolyExistentialPredicate<'tcx>>,
738         b_region: ty::Region<'tcx>,
739     ) -> CoerceResult<'tcx> {
740         if !self.tcx.features().dyn_star {
741             return Err(TypeError::Mismatch);
742         }
743
744         if let ty::Dynamic(a_data, _, _) = a.kind()
745             && let ty::Dynamic(b_data, _, _) = b.kind()
746         {
747             if a_data.principal_def_id() == b_data.principal_def_id() {
748                 return self.unify_and(a, b, |_| vec![]);
749             } else if !self.tcx().features().trait_upcasting {
750                 let mut err = feature_err(
751                     &self.tcx.sess.parse_sess,
752                     sym::trait_upcasting,
753                     self.cause.span,
754                     &format!(
755                         "cannot cast `{a}` to `{b}`, trait upcasting coercion is experimental"
756                     ),
757                 );
758                 err.emit();
759             }
760         }
761
762         // Check the obligations of the cast -- for example, when casting
763         // `usize` to `dyn* Clone + 'static`:
764         let mut obligations: Vec<_> = predicates
765             .iter()
766             .map(|predicate| {
767                 // For each existential predicate (e.g., `?Self: Clone`) substitute
768                 // the type of the expression (e.g., `usize` in our example above)
769                 // and then require that the resulting predicate (e.g., `usize: Clone`)
770                 // holds (it does).
771                 let predicate = predicate.with_self_ty(self.tcx, a);
772                 Obligation::new(self.tcx, self.cause.clone(), self.param_env, predicate)
773             })
774             .chain([
775                 // Enforce the region bound (e.g., `usize: 'static`, in our example).
776                 Obligation::new(
777                     self.tcx,
778                     self.cause.clone(),
779                     self.param_env,
780                     ty::Binder::dummy(ty::PredicateKind::TypeOutlives(ty::OutlivesPredicate(
781                         a, b_region,
782                     ))),
783                 ),
784             ])
785             .collect();
786
787         // Enforce that the type is `usize`/pointer-sized. For now, only those
788         // can be coerced to `dyn*`, except for `dyn* -> dyn*` upcasts.
789         if !a.is_dyn_star() {
790             obligations.push(Obligation::new(
791                 self.tcx,
792                 self.cause.clone(),
793                 self.param_env,
794                 ty::Binder::dummy(
795                     self.tcx.at(self.cause.span).mk_trait_ref(hir::LangItem::PointerSized, [a]),
796                 )
797                 .to_poly_trait_predicate(),
798             ));
799         }
800
801         Ok(InferOk {
802             value: (vec![Adjustment { kind: Adjust::DynStar, target: b }], b),
803             obligations,
804         })
805     }
806
807     fn coerce_from_safe_fn<F, G>(
808         &self,
809         a: Ty<'tcx>,
810         fn_ty_a: ty::PolyFnSig<'tcx>,
811         b: Ty<'tcx>,
812         to_unsafe: F,
813         normal: G,
814     ) -> CoerceResult<'tcx>
815     where
816         F: FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
817         G: FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
818     {
819         self.commit_if_ok(|snapshot| {
820             let result = if let ty::FnPtr(fn_ty_b) = b.kind()
821                 && let (hir::Unsafety::Normal, hir::Unsafety::Unsafe) =
822                     (fn_ty_a.unsafety(), fn_ty_b.unsafety())
823             {
824                 let unsafe_a = self.tcx.safe_to_unsafe_fn_ty(fn_ty_a);
825                 self.unify_and(unsafe_a, b, to_unsafe)
826             } else {
827                 self.unify_and(a, b, normal)
828             };
829
830             // FIXME(#73154): This is a hack. Currently LUB can generate
831             // unsolvable constraints. Additionally, it returns `a`
832             // unconditionally, even when the "LUB" is `b`. In the future, we
833             // want the coerced type to be the actual supertype of these two,
834             // but for now, we want to just error to ensure we don't lock
835             // ourselves into a specific behavior with NLL.
836             self.leak_check(false, snapshot)?;
837
838             result
839         })
840     }
841
842     fn coerce_from_fn_pointer(
843         &self,
844         a: Ty<'tcx>,
845         fn_ty_a: ty::PolyFnSig<'tcx>,
846         b: Ty<'tcx>,
847     ) -> CoerceResult<'tcx> {
848         //! Attempts to coerce from the type of a Rust function item
849         //! into a closure or a `proc`.
850         //!
851
852         let b = self.shallow_resolve(b);
853         debug!("coerce_from_fn_pointer(a={:?}, b={:?})", a, b);
854
855         self.coerce_from_safe_fn(
856             a,
857             fn_ty_a,
858             b,
859             simple(Adjust::Pointer(PointerCast::UnsafeFnPointer)),
860             identity,
861         )
862     }
863
864     fn coerce_from_fn_item(&self, a: Ty<'tcx>, b: Ty<'tcx>) -> CoerceResult<'tcx> {
865         //! Attempts to coerce from the type of a Rust function item
866         //! into a closure or a `proc`.
867
868         let b = self.shallow_resolve(b);
869         let InferOk { value: b, mut obligations } =
870             self.normalize_associated_types_in_as_infer_ok(self.cause.span, b);
871         debug!("coerce_from_fn_item(a={:?}, b={:?})", a, b);
872
873         match b.kind() {
874             ty::FnPtr(b_sig) => {
875                 let a_sig = a.fn_sig(self.tcx);
876                 if let ty::FnDef(def_id, _) = *a.kind() {
877                     // Intrinsics are not coercible to function pointers
878                     if self.tcx.is_intrinsic(def_id) {
879                         return Err(TypeError::IntrinsicCast);
880                     }
881
882                     // Safe `#[target_feature]` functions are not assignable to safe fn pointers (RFC 2396).
883
884                     if b_sig.unsafety() == hir::Unsafety::Normal
885                         && !self.tcx.codegen_fn_attrs(def_id).target_features.is_empty()
886                     {
887                         return Err(TypeError::TargetFeatureCast(def_id));
888                     }
889                 }
890
891                 let InferOk { value: a_sig, obligations: o1 } =
892                     self.normalize_associated_types_in_as_infer_ok(self.cause.span, a_sig);
893                 obligations.extend(o1);
894
895                 let a_fn_pointer = self.tcx.mk_fn_ptr(a_sig);
896                 let InferOk { value, obligations: o2 } = self.coerce_from_safe_fn(
897                     a_fn_pointer,
898                     a_sig,
899                     b,
900                     |unsafe_ty| {
901                         vec![
902                             Adjustment {
903                                 kind: Adjust::Pointer(PointerCast::ReifyFnPointer),
904                                 target: a_fn_pointer,
905                             },
906                             Adjustment {
907                                 kind: Adjust::Pointer(PointerCast::UnsafeFnPointer),
908                                 target: unsafe_ty,
909                             },
910                         ]
911                     },
912                     simple(Adjust::Pointer(PointerCast::ReifyFnPointer)),
913                 )?;
914
915                 obligations.extend(o2);
916                 Ok(InferOk { value, obligations })
917             }
918             _ => self.unify_and(a, b, identity),
919         }
920     }
921
922     fn coerce_closure_to_fn(
923         &self,
924         a: Ty<'tcx>,
925         closure_def_id_a: DefId,
926         substs_a: SubstsRef<'tcx>,
927         b: Ty<'tcx>,
928     ) -> CoerceResult<'tcx> {
929         //! Attempts to coerce from the type of a non-capturing closure
930         //! into a function pointer.
931         //!
932
933         let b = self.shallow_resolve(b);
934
935         match b.kind() {
936             // At this point we haven't done capture analysis, which means
937             // that the ClosureSubsts just contains an inference variable instead
938             // of tuple of captured types.
939             //
940             // All we care here is if any variable is being captured and not the exact paths,
941             // so we check `upvars_mentioned` for root variables being captured.
942             ty::FnPtr(fn_ty)
943                 if self
944                     .tcx
945                     .upvars_mentioned(closure_def_id_a.expect_local())
946                     .map_or(true, |u| u.is_empty()) =>
947             {
948                 // We coerce the closure, which has fn type
949                 //     `extern "rust-call" fn((arg0,arg1,...)) -> _`
950                 // to
951                 //     `fn(arg0,arg1,...) -> _`
952                 // or
953                 //     `unsafe fn(arg0,arg1,...) -> _`
954                 let closure_sig = substs_a.as_closure().sig();
955                 let unsafety = fn_ty.unsafety();
956                 let pointer_ty =
957                     self.tcx.mk_fn_ptr(self.tcx.signature_unclosure(closure_sig, unsafety));
958                 debug!("coerce_closure_to_fn(a={:?}, b={:?}, pty={:?})", a, b, pointer_ty);
959                 self.unify_and(
960                     pointer_ty,
961                     b,
962                     simple(Adjust::Pointer(PointerCast::ClosureFnPointer(unsafety))),
963                 )
964             }
965             _ => self.unify_and(a, b, identity),
966         }
967     }
968
969     fn coerce_unsafe_ptr(
970         &self,
971         a: Ty<'tcx>,
972         b: Ty<'tcx>,
973         mutbl_b: hir::Mutability,
974     ) -> CoerceResult<'tcx> {
975         debug!("coerce_unsafe_ptr(a={:?}, b={:?})", a, b);
976
977         let (is_ref, mt_a) = match *a.kind() {
978             ty::Ref(_, ty, mutbl) => (true, ty::TypeAndMut { ty, mutbl }),
979             ty::RawPtr(mt) => (false, mt),
980             _ => return self.unify_and(a, b, identity),
981         };
982         coerce_mutbls(mt_a.mutbl, mutbl_b)?;
983
984         // Check that the types which they point at are compatible.
985         let a_unsafe = self.tcx.mk_ptr(ty::TypeAndMut { mutbl: mutbl_b, ty: mt_a.ty });
986         // Although references and unsafe ptrs have the same
987         // representation, we still register an Adjust::DerefRef so that
988         // regionck knows that the region for `a` must be valid here.
989         if is_ref {
990             self.unify_and(a_unsafe, b, |target| {
991                 vec![
992                     Adjustment { kind: Adjust::Deref(None), target: mt_a.ty },
993                     Adjustment { kind: Adjust::Borrow(AutoBorrow::RawPtr(mutbl_b)), target },
994                 ]
995             })
996         } else if mt_a.mutbl != mutbl_b {
997             self.unify_and(a_unsafe, b, simple(Adjust::Pointer(PointerCast::MutToConstPointer)))
998         } else {
999             self.unify_and(a_unsafe, b, identity)
1000         }
1001     }
1002 }
1003
1004 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
1005     /// Attempt to coerce an expression to a type, and return the
1006     /// adjusted type of the expression, if successful.
1007     /// Adjustments are only recorded if the coercion succeeded.
1008     /// The expressions *must not* have any pre-existing adjustments.
1009     pub fn try_coerce(
1010         &self,
1011         expr: &hir::Expr<'_>,
1012         expr_ty: Ty<'tcx>,
1013         target: Ty<'tcx>,
1014         allow_two_phase: AllowTwoPhase,
1015         cause: Option<ObligationCause<'tcx>>,
1016     ) -> RelateResult<'tcx, Ty<'tcx>> {
1017         let source = self.resolve_vars_with_obligations(expr_ty);
1018         debug!("coercion::try({:?}: {:?} -> {:?})", expr, source, target);
1019
1020         let cause =
1021             cause.unwrap_or_else(|| self.cause(expr.span, ObligationCauseCode::ExprAssignable));
1022         let coerce = Coerce::new(self, cause, allow_two_phase);
1023         let ok = self.commit_if_ok(|_| coerce.coerce(source, target))?;
1024
1025         let (adjustments, _) = self.register_infer_ok_obligations(ok);
1026         self.apply_adjustments(expr, adjustments);
1027         Ok(if expr_ty.references_error() { self.tcx.ty_error() } else { target })
1028     }
1029
1030     /// Same as `try_coerce()`, but without side-effects.
1031     ///
1032     /// Returns false if the coercion creates any obligations that result in
1033     /// errors.
1034     pub fn can_coerce(&self, expr_ty: Ty<'tcx>, target: Ty<'tcx>) -> bool {
1035         let source = self.resolve_vars_with_obligations(expr_ty);
1036         debug!("coercion::can_with_predicates({:?} -> {:?})", source, target);
1037
1038         let cause = self.cause(rustc_span::DUMMY_SP, ObligationCauseCode::ExprAssignable);
1039         // We don't ever need two-phase here since we throw out the result of the coercion
1040         let coerce = Coerce::new(self, cause, AllowTwoPhase::No);
1041         self.probe(|_| {
1042             let Ok(ok) = coerce.coerce(source, target) else {
1043                 return false;
1044             };
1045             let ocx = ObligationCtxt::new_in_snapshot(self);
1046             ocx.register_obligations(ok.obligations);
1047             ocx.select_where_possible().is_empty()
1048         })
1049     }
1050
1051     /// Given a type and a target type, this function will calculate and return
1052     /// how many dereference steps needed to achieve `expr_ty <: target`. If
1053     /// it's not possible, return `None`.
1054     pub fn deref_steps(&self, expr_ty: Ty<'tcx>, target: Ty<'tcx>) -> Option<usize> {
1055         let cause = self.cause(rustc_span::DUMMY_SP, ObligationCauseCode::ExprAssignable);
1056         // We don't ever need two-phase here since we throw out the result of the coercion
1057         let coerce = Coerce::new(self, cause, AllowTwoPhase::No);
1058         coerce
1059             .autoderef(rustc_span::DUMMY_SP, expr_ty)
1060             .find_map(|(ty, steps)| self.probe(|_| coerce.unify(ty, target)).ok().map(|_| steps))
1061     }
1062
1063     /// Given a type, this function will calculate and return the type given
1064     /// for `<Ty as Deref>::Target` only if `Ty` also implements `DerefMut`.
1065     ///
1066     /// This function is for diagnostics only, since it does not register
1067     /// trait or region sub-obligations. (presumably we could, but it's not
1068     /// particularly important for diagnostics...)
1069     pub fn deref_once_mutably_for_diagnostic(&self, expr_ty: Ty<'tcx>) -> Option<Ty<'tcx>> {
1070         self.autoderef(rustc_span::DUMMY_SP, expr_ty).nth(1).and_then(|(deref_ty, _)| {
1071             self.infcx
1072                 .type_implements_trait(
1073                     self.tcx.lang_items().deref_mut_trait()?,
1074                     [expr_ty],
1075                     self.param_env,
1076                 )
1077                 .may_apply()
1078                 .then(|| deref_ty)
1079         })
1080     }
1081
1082     /// Given some expressions, their known unified type and another expression,
1083     /// tries to unify the types, potentially inserting coercions on any of the
1084     /// provided expressions and returns their LUB (aka "common supertype").
1085     ///
1086     /// This is really an internal helper. From outside the coercion
1087     /// module, you should instantiate a `CoerceMany` instance.
1088     fn try_find_coercion_lub<E>(
1089         &self,
1090         cause: &ObligationCause<'tcx>,
1091         exprs: &[E],
1092         prev_ty: Ty<'tcx>,
1093         new: &hir::Expr<'_>,
1094         new_ty: Ty<'tcx>,
1095     ) -> RelateResult<'tcx, Ty<'tcx>>
1096     where
1097         E: AsCoercionSite,
1098     {
1099         let prev_ty = self.resolve_vars_with_obligations(prev_ty);
1100         let new_ty = self.resolve_vars_with_obligations(new_ty);
1101         debug!(
1102             "coercion::try_find_coercion_lub({:?}, {:?}, exprs={:?} exprs)",
1103             prev_ty,
1104             new_ty,
1105             exprs.len()
1106         );
1107
1108         // The following check fixes #88097, where the compiler erroneously
1109         // attempted to coerce a closure type to itself via a function pointer.
1110         if prev_ty == new_ty {
1111             return Ok(prev_ty);
1112         }
1113
1114         // Special-case that coercion alone cannot handle:
1115         // Function items or non-capturing closures of differing IDs or InternalSubsts.
1116         let (a_sig, b_sig) = {
1117             #[allow(rustc::usage_of_ty_tykind)]
1118             let is_capturing_closure = |ty: &ty::TyKind<'tcx>| {
1119                 if let &ty::Closure(closure_def_id, _substs) = ty {
1120                     self.tcx.upvars_mentioned(closure_def_id.expect_local()).is_some()
1121                 } else {
1122                     false
1123                 }
1124             };
1125             if is_capturing_closure(prev_ty.kind()) || is_capturing_closure(new_ty.kind()) {
1126                 (None, None)
1127             } else {
1128                 match (prev_ty.kind(), new_ty.kind()) {
1129                     (ty::FnDef(..), ty::FnDef(..)) => {
1130                         // Don't reify if the function types have a LUB, i.e., they
1131                         // are the same function and their parameters have a LUB.
1132                         match self
1133                             .commit_if_ok(|_| self.at(cause, self.param_env).lub(prev_ty, new_ty))
1134                         {
1135                             // We have a LUB of prev_ty and new_ty, just return it.
1136                             Ok(ok) => return Ok(self.register_infer_ok_obligations(ok)),
1137                             Err(_) => {
1138                                 (Some(prev_ty.fn_sig(self.tcx)), Some(new_ty.fn_sig(self.tcx)))
1139                             }
1140                         }
1141                     }
1142                     (ty::Closure(_, substs), ty::FnDef(..)) => {
1143                         let b_sig = new_ty.fn_sig(self.tcx);
1144                         let a_sig = self
1145                             .tcx
1146                             .signature_unclosure(substs.as_closure().sig(), b_sig.unsafety());
1147                         (Some(a_sig), Some(b_sig))
1148                     }
1149                     (ty::FnDef(..), ty::Closure(_, substs)) => {
1150                         let a_sig = prev_ty.fn_sig(self.tcx);
1151                         let b_sig = self
1152                             .tcx
1153                             .signature_unclosure(substs.as_closure().sig(), a_sig.unsafety());
1154                         (Some(a_sig), Some(b_sig))
1155                     }
1156                     (ty::Closure(_, substs_a), ty::Closure(_, substs_b)) => (
1157                         Some(self.tcx.signature_unclosure(
1158                             substs_a.as_closure().sig(),
1159                             hir::Unsafety::Normal,
1160                         )),
1161                         Some(self.tcx.signature_unclosure(
1162                             substs_b.as_closure().sig(),
1163                             hir::Unsafety::Normal,
1164                         )),
1165                     ),
1166                     _ => (None, None),
1167                 }
1168             }
1169         };
1170         if let (Some(a_sig), Some(b_sig)) = (a_sig, b_sig) {
1171             // Intrinsics are not coercible to function pointers.
1172             if a_sig.abi() == Abi::RustIntrinsic
1173                 || a_sig.abi() == Abi::PlatformIntrinsic
1174                 || b_sig.abi() == Abi::RustIntrinsic
1175                 || b_sig.abi() == Abi::PlatformIntrinsic
1176             {
1177                 return Err(TypeError::IntrinsicCast);
1178             }
1179             // The signature must match.
1180             let a_sig = self.normalize_associated_types_in(new.span, a_sig);
1181             let b_sig = self.normalize_associated_types_in(new.span, b_sig);
1182             let sig = self
1183                 .at(cause, self.param_env)
1184                 .trace(prev_ty, new_ty)
1185                 .lub(a_sig, b_sig)
1186                 .map(|ok| self.register_infer_ok_obligations(ok))?;
1187
1188             // Reify both sides and return the reified fn pointer type.
1189             let fn_ptr = self.tcx.mk_fn_ptr(sig);
1190             let prev_adjustment = match prev_ty.kind() {
1191                 ty::Closure(..) => Adjust::Pointer(PointerCast::ClosureFnPointer(a_sig.unsafety())),
1192                 ty::FnDef(..) => Adjust::Pointer(PointerCast::ReifyFnPointer),
1193                 _ => unreachable!(),
1194             };
1195             let next_adjustment = match new_ty.kind() {
1196                 ty::Closure(..) => Adjust::Pointer(PointerCast::ClosureFnPointer(b_sig.unsafety())),
1197                 ty::FnDef(..) => Adjust::Pointer(PointerCast::ReifyFnPointer),
1198                 _ => unreachable!(),
1199             };
1200             for expr in exprs.iter().map(|e| e.as_coercion_site()) {
1201                 self.apply_adjustments(
1202                     expr,
1203                     vec![Adjustment { kind: prev_adjustment.clone(), target: fn_ptr }],
1204                 );
1205             }
1206             self.apply_adjustments(new, vec![Adjustment { kind: next_adjustment, target: fn_ptr }]);
1207             return Ok(fn_ptr);
1208         }
1209
1210         // Configure a Coerce instance to compute the LUB.
1211         // We don't allow two-phase borrows on any autorefs this creates since we
1212         // probably aren't processing function arguments here and even if we were,
1213         // they're going to get autorefed again anyway and we can apply 2-phase borrows
1214         // at that time.
1215         let mut coerce = Coerce::new(self, cause.clone(), AllowTwoPhase::No);
1216         coerce.use_lub = true;
1217
1218         // First try to coerce the new expression to the type of the previous ones,
1219         // but only if the new expression has no coercion already applied to it.
1220         let mut first_error = None;
1221         if !self.typeck_results.borrow().adjustments().contains_key(new.hir_id) {
1222             let result = self.commit_if_ok(|_| coerce.coerce(new_ty, prev_ty));
1223             match result {
1224                 Ok(ok) => {
1225                     let (adjustments, target) = self.register_infer_ok_obligations(ok);
1226                     self.apply_adjustments(new, adjustments);
1227                     debug!(
1228                         "coercion::try_find_coercion_lub: was able to coerce from new type {:?} to previous type {:?} ({:?})",
1229                         new_ty, prev_ty, target
1230                     );
1231                     return Ok(target);
1232                 }
1233                 Err(e) => first_error = Some(e),
1234             }
1235         }
1236
1237         // Then try to coerce the previous expressions to the type of the new one.
1238         // This requires ensuring there are no coercions applied to *any* of the
1239         // previous expressions, other than noop reborrows (ignoring lifetimes).
1240         for expr in exprs {
1241             let expr = expr.as_coercion_site();
1242             let noop = match self.typeck_results.borrow().expr_adjustments(expr) {
1243                 &[
1244                     Adjustment { kind: Adjust::Deref(_), .. },
1245                     Adjustment { kind: Adjust::Borrow(AutoBorrow::Ref(_, mutbl_adj)), .. },
1246                 ] => {
1247                     match *self.node_ty(expr.hir_id).kind() {
1248                         ty::Ref(_, _, mt_orig) => {
1249                             let mutbl_adj: hir::Mutability = mutbl_adj.into();
1250                             // Reborrow that we can safely ignore, because
1251                             // the next adjustment can only be a Deref
1252                             // which will be merged into it.
1253                             mutbl_adj == mt_orig
1254                         }
1255                         _ => false,
1256                     }
1257                 }
1258                 &[Adjustment { kind: Adjust::NeverToAny, .. }] | &[] => true,
1259                 _ => false,
1260             };
1261
1262             if !noop {
1263                 debug!(
1264                     "coercion::try_find_coercion_lub: older expression {:?} had adjustments, requiring LUB",
1265                     expr,
1266                 );
1267
1268                 return self
1269                     .commit_if_ok(|_| self.at(cause, self.param_env).lub(prev_ty, new_ty))
1270                     .map(|ok| self.register_infer_ok_obligations(ok));
1271             }
1272         }
1273
1274         match self.commit_if_ok(|_| coerce.coerce(prev_ty, new_ty)) {
1275             Err(_) => {
1276                 // Avoid giving strange errors on failed attempts.
1277                 if let Some(e) = first_error {
1278                     Err(e)
1279                 } else {
1280                     self.commit_if_ok(|_| self.at(cause, self.param_env).lub(prev_ty, new_ty))
1281                         .map(|ok| self.register_infer_ok_obligations(ok))
1282                 }
1283             }
1284             Ok(ok) => {
1285                 let (adjustments, target) = self.register_infer_ok_obligations(ok);
1286                 for expr in exprs {
1287                     let expr = expr.as_coercion_site();
1288                     self.apply_adjustments(expr, adjustments.clone());
1289                 }
1290                 debug!(
1291                     "coercion::try_find_coercion_lub: was able to coerce previous type {:?} to new type {:?} ({:?})",
1292                     prev_ty, new_ty, target
1293                 );
1294                 Ok(target)
1295             }
1296         }
1297     }
1298 }
1299
1300 /// CoerceMany encapsulates the pattern you should use when you have
1301 /// many expressions that are all getting coerced to a common
1302 /// type. This arises, for example, when you have a match (the result
1303 /// of each arm is coerced to a common type). It also arises in less
1304 /// obvious places, such as when you have many `break foo` expressions
1305 /// that target the same loop, or the various `return` expressions in
1306 /// a function.
1307 ///
1308 /// The basic protocol is as follows:
1309 ///
1310 /// - Instantiate the `CoerceMany` with an initial `expected_ty`.
1311 ///   This will also serve as the "starting LUB". The expectation is
1312 ///   that this type is something which all of the expressions *must*
1313 ///   be coercible to. Use a fresh type variable if needed.
1314 /// - For each expression whose result is to be coerced, invoke `coerce()` with.
1315 ///   - In some cases we wish to coerce "non-expressions" whose types are implicitly
1316 ///     unit. This happens for example if you have a `break` with no expression,
1317 ///     or an `if` with no `else`. In that case, invoke `coerce_forced_unit()`.
1318 ///   - `coerce()` and `coerce_forced_unit()` may report errors. They hide this
1319 ///     from you so that you don't have to worry your pretty head about it.
1320 ///     But if an error is reported, the final type will be `err`.
1321 ///   - Invoking `coerce()` may cause us to go and adjust the "adjustments" on
1322 ///     previously coerced expressions.
1323 /// - When all done, invoke `complete()`. This will return the LUB of
1324 ///   all your expressions.
1325 ///   - WARNING: I don't believe this final type is guaranteed to be
1326 ///     related to your initial `expected_ty` in any particular way,
1327 ///     although it will typically be a subtype, so you should check it.
1328 ///   - Invoking `complete()` may cause us to go and adjust the "adjustments" on
1329 ///     previously coerced expressions.
1330 ///
1331 /// Example:
1332 ///
1333 /// ```ignore (illustrative)
1334 /// let mut coerce = CoerceMany::new(expected_ty);
1335 /// for expr in exprs {
1336 ///     let expr_ty = fcx.check_expr_with_expectation(expr, expected);
1337 ///     coerce.coerce(fcx, &cause, expr, expr_ty);
1338 /// }
1339 /// let final_ty = coerce.complete(fcx);
1340 /// ```
1341 pub struct CoerceMany<'tcx, 'exprs, E: AsCoercionSite> {
1342     expected_ty: Ty<'tcx>,
1343     final_ty: Option<Ty<'tcx>>,
1344     expressions: Expressions<'tcx, 'exprs, E>,
1345     pushed: usize,
1346 }
1347
1348 /// The type of a `CoerceMany` that is storing up the expressions into
1349 /// a buffer. We use this in `check/mod.rs` for things like `break`.
1350 pub type DynamicCoerceMany<'tcx> = CoerceMany<'tcx, 'tcx, &'tcx hir::Expr<'tcx>>;
1351
1352 enum Expressions<'tcx, 'exprs, E: AsCoercionSite> {
1353     Dynamic(Vec<&'tcx hir::Expr<'tcx>>),
1354     UpFront(&'exprs [E]),
1355 }
1356
1357 impl<'tcx, 'exprs, E: AsCoercionSite> CoerceMany<'tcx, 'exprs, E> {
1358     /// The usual case; collect the set of expressions dynamically.
1359     /// If the full set of coercion sites is known before hand,
1360     /// consider `with_coercion_sites()` instead to avoid allocation.
1361     pub fn new(expected_ty: Ty<'tcx>) -> Self {
1362         Self::make(expected_ty, Expressions::Dynamic(vec![]))
1363     }
1364
1365     /// As an optimization, you can create a `CoerceMany` with a
1366     /// pre-existing slice of expressions. In this case, you are
1367     /// expected to pass each element in the slice to `coerce(...)` in
1368     /// order. This is used with arrays in particular to avoid
1369     /// needlessly cloning the slice.
1370     pub fn with_coercion_sites(expected_ty: Ty<'tcx>, coercion_sites: &'exprs [E]) -> Self {
1371         Self::make(expected_ty, Expressions::UpFront(coercion_sites))
1372     }
1373
1374     fn make(expected_ty: Ty<'tcx>, expressions: Expressions<'tcx, 'exprs, E>) -> Self {
1375         CoerceMany { expected_ty, final_ty: None, expressions, pushed: 0 }
1376     }
1377
1378     /// Returns the "expected type" with which this coercion was
1379     /// constructed. This represents the "downward propagated" type
1380     /// that was given to us at the start of typing whatever construct
1381     /// we are typing (e.g., the match expression).
1382     ///
1383     /// Typically, this is used as the expected type when
1384     /// type-checking each of the alternative expressions whose types
1385     /// we are trying to merge.
1386     pub fn expected_ty(&self) -> Ty<'tcx> {
1387         self.expected_ty
1388     }
1389
1390     /// Returns the current "merged type", representing our best-guess
1391     /// at the LUB of the expressions we've seen so far (if any). This
1392     /// isn't *final* until you call `self.complete()`, which will return
1393     /// the merged type.
1394     pub fn merged_ty(&self) -> Ty<'tcx> {
1395         self.final_ty.unwrap_or(self.expected_ty)
1396     }
1397
1398     /// Indicates that the value generated by `expression`, which is
1399     /// of type `expression_ty`, is one of the possibilities that we
1400     /// could coerce from. This will record `expression`, and later
1401     /// calls to `coerce` may come back and add adjustments and things
1402     /// if necessary.
1403     pub fn coerce<'a>(
1404         &mut self,
1405         fcx: &FnCtxt<'a, 'tcx>,
1406         cause: &ObligationCause<'tcx>,
1407         expression: &'tcx hir::Expr<'tcx>,
1408         expression_ty: Ty<'tcx>,
1409     ) {
1410         self.coerce_inner(fcx, cause, Some(expression), expression_ty, None, false)
1411     }
1412
1413     /// Indicates that one of the inputs is a "forced unit". This
1414     /// occurs in a case like `if foo { ... };`, where the missing else
1415     /// generates a "forced unit". Another example is a `loop { break;
1416     /// }`, where the `break` has no argument expression. We treat
1417     /// these cases slightly differently for error-reporting
1418     /// purposes. Note that these tend to correspond to cases where
1419     /// the `()` expression is implicit in the source, and hence we do
1420     /// not take an expression argument.
1421     ///
1422     /// The `augment_error` gives you a chance to extend the error
1423     /// message, in case any results (e.g., we use this to suggest
1424     /// removing a `;`).
1425     pub fn coerce_forced_unit<'a>(
1426         &mut self,
1427         fcx: &FnCtxt<'a, 'tcx>,
1428         cause: &ObligationCause<'tcx>,
1429         augment_error: &mut dyn FnMut(&mut Diagnostic),
1430         label_unit_as_expected: bool,
1431     ) {
1432         self.coerce_inner(
1433             fcx,
1434             cause,
1435             None,
1436             fcx.tcx.mk_unit(),
1437             Some(augment_error),
1438             label_unit_as_expected,
1439         )
1440     }
1441
1442     /// The inner coercion "engine". If `expression` is `None`, this
1443     /// is a forced-unit case, and hence `expression_ty` must be
1444     /// `Nil`.
1445     #[instrument(skip(self, fcx, augment_error, label_expression_as_expected), level = "debug")]
1446     pub(crate) fn coerce_inner<'a>(
1447         &mut self,
1448         fcx: &FnCtxt<'a, 'tcx>,
1449         cause: &ObligationCause<'tcx>,
1450         expression: Option<&'tcx hir::Expr<'tcx>>,
1451         mut expression_ty: Ty<'tcx>,
1452         augment_error: Option<&mut dyn FnMut(&mut Diagnostic)>,
1453         label_expression_as_expected: bool,
1454     ) {
1455         // Incorporate whatever type inference information we have
1456         // until now; in principle we might also want to process
1457         // pending obligations, but doing so should only improve
1458         // compatibility (hopefully that is true) by helping us
1459         // uncover never types better.
1460         if expression_ty.is_ty_var() {
1461             expression_ty = fcx.infcx.shallow_resolve(expression_ty);
1462         }
1463
1464         // If we see any error types, just propagate that error
1465         // upwards.
1466         if expression_ty.references_error() || self.merged_ty().references_error() {
1467             self.final_ty = Some(fcx.tcx.ty_error());
1468             return;
1469         }
1470
1471         // Handle the actual type unification etc.
1472         let result = if let Some(expression) = expression {
1473             if self.pushed == 0 {
1474                 // Special-case the first expression we are coercing.
1475                 // To be honest, I'm not entirely sure why we do this.
1476                 // We don't allow two-phase borrows, see comment in try_find_coercion_lub for why
1477                 fcx.try_coerce(
1478                     expression,
1479                     expression_ty,
1480                     self.expected_ty,
1481                     AllowTwoPhase::No,
1482                     Some(cause.clone()),
1483                 )
1484             } else {
1485                 match self.expressions {
1486                     Expressions::Dynamic(ref exprs) => fcx.try_find_coercion_lub(
1487                         cause,
1488                         exprs,
1489                         self.merged_ty(),
1490                         expression,
1491                         expression_ty,
1492                     ),
1493                     Expressions::UpFront(ref coercion_sites) => fcx.try_find_coercion_lub(
1494                         cause,
1495                         &coercion_sites[0..self.pushed],
1496                         self.merged_ty(),
1497                         expression,
1498                         expression_ty,
1499                     ),
1500                 }
1501             }
1502         } else {
1503             // this is a hack for cases where we default to `()` because
1504             // the expression etc has been omitted from the source. An
1505             // example is an `if let` without an else:
1506             //
1507             //     if let Some(x) = ... { }
1508             //
1509             // we wind up with a second match arm that is like `_ =>
1510             // ()`.  That is the case we are considering here. We take
1511             // a different path to get the right "expected, found"
1512             // message and so forth (and because we know that
1513             // `expression_ty` will be unit).
1514             //
1515             // Another example is `break` with no argument expression.
1516             assert!(expression_ty.is_unit(), "if let hack without unit type");
1517             fcx.at(cause, fcx.param_env)
1518                 .eq_exp(label_expression_as_expected, expression_ty, self.merged_ty())
1519                 .map(|infer_ok| {
1520                     fcx.register_infer_ok_obligations(infer_ok);
1521                     expression_ty
1522                 })
1523         };
1524
1525         debug!(?result);
1526         match result {
1527             Ok(v) => {
1528                 self.final_ty = Some(v);
1529                 if let Some(e) = expression {
1530                     match self.expressions {
1531                         Expressions::Dynamic(ref mut buffer) => buffer.push(e),
1532                         Expressions::UpFront(coercion_sites) => {
1533                             // if the user gave us an array to validate, check that we got
1534                             // the next expression in the list, as expected
1535                             assert_eq!(
1536                                 coercion_sites[self.pushed].as_coercion_site().hir_id,
1537                                 e.hir_id
1538                             );
1539                         }
1540                     }
1541                     self.pushed += 1;
1542                 }
1543             }
1544             Err(coercion_error) => {
1545                 // Mark that we've failed to coerce the types here to suppress
1546                 // any superfluous errors we might encounter while trying to
1547                 // emit or provide suggestions on how to fix the initial error.
1548                 fcx.set_tainted_by_errors(
1549                     fcx.tcx.sess.delay_span_bug(cause.span, "coercion error but no error emitted"),
1550                 );
1551                 let (expected, found) = if label_expression_as_expected {
1552                     // In the case where this is a "forced unit", like
1553                     // `break`, we want to call the `()` "expected"
1554                     // since it is implied by the syntax.
1555                     // (Note: not all force-units work this way.)"
1556                     (expression_ty, self.merged_ty())
1557                 } else {
1558                     // Otherwise, the "expected" type for error
1559                     // reporting is the current unification type,
1560                     // which is basically the LUB of the expressions
1561                     // we've seen so far (combined with the expected
1562                     // type)
1563                     (self.merged_ty(), expression_ty)
1564                 };
1565                 let (expected, found) = fcx.resolve_vars_if_possible((expected, found));
1566
1567                 let mut err;
1568                 let mut unsized_return = false;
1569                 let mut visitor = CollectRetsVisitor { ret_exprs: vec![] };
1570                 match *cause.code() {
1571                     ObligationCauseCode::ReturnNoExpression => {
1572                         err = struct_span_err!(
1573                             fcx.tcx.sess,
1574                             cause.span,
1575                             E0069,
1576                             "`return;` in a function whose return type is not `()`"
1577                         );
1578                         err.span_label(cause.span, "return type is not `()`");
1579                     }
1580                     ObligationCauseCode::BlockTailExpression(blk_id) => {
1581                         let parent_id = fcx.tcx.hir().get_parent_node(blk_id);
1582                         err = self.report_return_mismatched_types(
1583                             cause,
1584                             expected,
1585                             found,
1586                             coercion_error.clone(),
1587                             fcx,
1588                             parent_id,
1589                             expression,
1590                             Some(blk_id),
1591                         );
1592                         if !fcx.tcx.features().unsized_locals {
1593                             unsized_return = self.is_return_ty_unsized(fcx, blk_id);
1594                         }
1595                         if let Some(expression) = expression
1596                             && let hir::ExprKind::Loop(loop_blk, ..) = expression.kind {
1597                               intravisit::walk_block(& mut visitor, loop_blk);
1598                         }
1599                     }
1600                     ObligationCauseCode::ReturnValue(id) => {
1601                         err = self.report_return_mismatched_types(
1602                             cause,
1603                             expected,
1604                             found,
1605                             coercion_error.clone(),
1606                             fcx,
1607                             id,
1608                             expression,
1609                             None,
1610                         );
1611                         if !fcx.tcx.features().unsized_locals {
1612                             let id = fcx.tcx.hir().get_parent_node(id);
1613                             unsized_return = self.is_return_ty_unsized(fcx, id);
1614                         }
1615                     }
1616                     _ => {
1617                         err = fcx.err_ctxt().report_mismatched_types(
1618                             cause,
1619                             expected,
1620                             found,
1621                             coercion_error.clone(),
1622                         );
1623                     }
1624                 }
1625
1626                 if let Some(augment_error) = augment_error {
1627                     augment_error(&mut err);
1628                 }
1629
1630                 let is_insufficiently_polymorphic =
1631                     matches!(coercion_error, TypeError::RegionsInsufficientlyPolymorphic(..));
1632
1633                 if !is_insufficiently_polymorphic && let Some(expr) = expression {
1634                     fcx.emit_coerce_suggestions(
1635                         &mut err,
1636                         expr,
1637                         found,
1638                         expected,
1639                         None,
1640                         Some(coercion_error),
1641                     );
1642                 }
1643
1644                 if visitor.ret_exprs.len() > 0 && let Some(expr) = expression {
1645                     self.note_unreachable_loop_return(&mut err, &expr, &visitor.ret_exprs);
1646                 }
1647                 let reported = err.emit_unless(unsized_return);
1648
1649                 self.final_ty = Some(fcx.tcx.ty_error_with_guaranteed(reported));
1650             }
1651         }
1652     }
1653     fn note_unreachable_loop_return(
1654         &self,
1655         err: &mut Diagnostic,
1656         expr: &hir::Expr<'tcx>,
1657         ret_exprs: &Vec<&'tcx hir::Expr<'tcx>>,
1658     ) {
1659         let hir::ExprKind::Loop(_, _, _, loop_span) = expr.kind else { return;};
1660         let mut span: MultiSpan = vec![loop_span].into();
1661         span.push_span_label(loop_span, "this might have zero elements to iterate on");
1662         const MAXITER: usize = 3;
1663         let iter = ret_exprs.iter().take(MAXITER);
1664         for ret_expr in iter {
1665             span.push_span_label(
1666                 ret_expr.span,
1667                 "if the loop doesn't execute, this value would never get returned",
1668             );
1669         }
1670         err.span_note(
1671             span,
1672             "the function expects a value to always be returned, but loops might run zero times",
1673         );
1674         if MAXITER < ret_exprs.len() {
1675             err.note(&format!(
1676                 "if the loop doesn't execute, {} other values would never get returned",
1677                 ret_exprs.len() - MAXITER
1678             ));
1679         }
1680         err.help(
1681             "return a value for the case when the loop has zero elements to iterate on, or \
1682            consider changing the return type to account for that possibility",
1683         );
1684     }
1685
1686     fn report_return_mismatched_types<'a>(
1687         &self,
1688         cause: &ObligationCause<'tcx>,
1689         expected: Ty<'tcx>,
1690         found: Ty<'tcx>,
1691         ty_err: TypeError<'tcx>,
1692         fcx: &FnCtxt<'a, 'tcx>,
1693         id: hir::HirId,
1694         expression: Option<&'tcx hir::Expr<'tcx>>,
1695         blk_id: Option<hir::HirId>,
1696     ) -> DiagnosticBuilder<'a, ErrorGuaranteed> {
1697         let mut err = fcx.err_ctxt().report_mismatched_types(cause, expected, found, ty_err);
1698
1699         let mut pointing_at_return_type = false;
1700         let mut fn_output = None;
1701
1702         let parent_id = fcx.tcx.hir().get_parent_node(id);
1703         let parent = fcx.tcx.hir().get(parent_id);
1704         if let Some(expr) = expression
1705             && let hir::Node::Expr(hir::Expr { kind: hir::ExprKind::Closure(&hir::Closure { body, .. }), .. }) = parent
1706             && !matches!(fcx.tcx.hir().body(body).value.kind, hir::ExprKind::Block(..))
1707         {
1708             fcx.suggest_missing_semicolon(&mut err, expr, expected, true);
1709         }
1710         // Verify that this is a tail expression of a function, otherwise the
1711         // label pointing out the cause for the type coercion will be wrong
1712         // as prior return coercions would not be relevant (#57664).
1713         let fn_decl = if let (Some(expr), Some(blk_id)) = (expression, blk_id) {
1714             pointing_at_return_type =
1715                 fcx.suggest_mismatched_types_on_tail(&mut err, expr, expected, found, blk_id);
1716             if let (Some(cond_expr), true, false) = (
1717                 fcx.tcx.hir().get_if_cause(expr.hir_id),
1718                 expected.is_unit(),
1719                 pointing_at_return_type,
1720             )
1721                 // If the block is from an external macro or try (`?`) desugaring, then
1722                 // do not suggest adding a semicolon, because there's nowhere to put it.
1723                 // See issues #81943 and #87051.
1724                 && matches!(
1725                     cond_expr.span.desugaring_kind(),
1726                     None | Some(DesugaringKind::WhileLoop)
1727                 ) && !in_external_macro(fcx.tcx.sess, cond_expr.span)
1728                     && !matches!(
1729                         cond_expr.kind,
1730                         hir::ExprKind::Match(.., hir::MatchSource::TryDesugar)
1731                     )
1732             {
1733                 err.span_label(cond_expr.span, "expected this to be `()`");
1734                 if expr.can_have_side_effects() {
1735                     fcx.suggest_semicolon_at_end(cond_expr.span, &mut err);
1736                 }
1737             }
1738             fcx.get_node_fn_decl(parent).map(|(fn_decl, _, is_main)| (fn_decl, is_main))
1739         } else {
1740             fcx.get_fn_decl(parent_id)
1741         };
1742
1743         if let Some((fn_decl, can_suggest)) = fn_decl {
1744             if blk_id.is_none() {
1745                 pointing_at_return_type |= fcx.suggest_missing_return_type(
1746                     &mut err,
1747                     &fn_decl,
1748                     expected,
1749                     found,
1750                     can_suggest,
1751                     fcx.tcx.hir().get_parent_item(id).into(),
1752                 );
1753             }
1754             if !pointing_at_return_type {
1755                 fn_output = Some(&fn_decl.output); // `impl Trait` return type
1756             }
1757         }
1758
1759         let parent_id = fcx.tcx.hir().get_parent_item(id);
1760         let parent_item = fcx.tcx.hir().get_by_def_id(parent_id.def_id);
1761
1762         if let (Some(expr), Some(_), Some((fn_decl, _, _))) =
1763             (expression, blk_id, fcx.get_node_fn_decl(parent_item))
1764         {
1765             fcx.suggest_missing_break_or_return_expr(
1766                 &mut err,
1767                 expr,
1768                 fn_decl,
1769                 expected,
1770                 found,
1771                 id,
1772                 parent_id.into(),
1773             );
1774         }
1775
1776         let ret_coercion_span = fcx.ret_coercion_span.get();
1777
1778         if let Some(sp) = ret_coercion_span
1779             // If the closure has an explicit return type annotation, or if
1780             // the closure's return type has been inferred from outside
1781             // requirements (such as an Fn* trait bound), then a type error
1782             // may occur at the first return expression we see in the closure
1783             // (if it conflicts with the declared return type). Skip adding a
1784             // note in this case, since it would be incorrect.
1785             && let Some(fn_sig) = fcx.body_fn_sig()
1786             && fn_sig.output().is_ty_var()
1787         {
1788             err.span_note(
1789                 sp,
1790                 &format!(
1791                     "return type inferred to be `{}` here",
1792                     expected
1793                 ),
1794             );
1795         }
1796
1797         if let (Some(sp), Some(fn_output)) = (ret_coercion_span, fn_output) {
1798             self.add_impl_trait_explanation(&mut err, cause, fcx, expected, sp, fn_output);
1799         }
1800
1801         err
1802     }
1803
1804     fn add_impl_trait_explanation<'a>(
1805         &self,
1806         err: &mut Diagnostic,
1807         cause: &ObligationCause<'tcx>,
1808         fcx: &FnCtxt<'a, 'tcx>,
1809         expected: Ty<'tcx>,
1810         sp: Span,
1811         fn_output: &hir::FnRetTy<'_>,
1812     ) {
1813         let return_sp = fn_output.span();
1814         err.span_label(return_sp, "expected because this return type...");
1815         err.span_label(
1816             sp,
1817             format!("...is found to be `{}` here", fcx.resolve_vars_with_obligations(expected)),
1818         );
1819         let impl_trait_msg = "for information on `impl Trait`, see \
1820                 <https://doc.rust-lang.org/book/ch10-02-traits.html\
1821                 #returning-types-that-implement-traits>";
1822         let trait_obj_msg = "for information on trait objects, see \
1823                 <https://doc.rust-lang.org/book/ch17-02-trait-objects.html\
1824                 #using-trait-objects-that-allow-for-values-of-different-types>";
1825         err.note("to return `impl Trait`, all returned values must be of the same type");
1826         err.note(impl_trait_msg);
1827         let snippet = fcx
1828             .tcx
1829             .sess
1830             .source_map()
1831             .span_to_snippet(return_sp)
1832             .unwrap_or_else(|_| "dyn Trait".to_string());
1833         let mut snippet_iter = snippet.split_whitespace();
1834         let has_impl = snippet_iter.next().map_or(false, |s| s == "impl");
1835         // Only suggest `Box<dyn Trait>` if `Trait` in `impl Trait` is object safe.
1836         let mut is_object_safe = false;
1837         if let hir::FnRetTy::Return(ty) = fn_output
1838             // Get the return type.
1839             && let hir::TyKind::OpaqueDef(..) = ty.kind
1840         {
1841             let ty = <dyn AstConv<'_>>::ast_ty_to_ty(fcx, ty);
1842             // Get the `impl Trait`'s `DefId`.
1843             if let ty::Opaque(def_id, _) = ty.kind()
1844                 // Get the `impl Trait`'s `Item` so that we can get its trait bounds and
1845                 // get the `Trait`'s `DefId`.
1846                 && let hir::ItemKind::OpaqueTy(hir::OpaqueTy { bounds, .. }) =
1847                     fcx.tcx.hir().expect_item(def_id.expect_local()).kind
1848             {
1849                 // Are of this `impl Trait`'s traits object safe?
1850                 is_object_safe = bounds.iter().all(|bound| {
1851                     bound
1852                         .trait_ref()
1853                         .and_then(|t| t.trait_def_id())
1854                         .map_or(false, |def_id| {
1855                             fcx.tcx.object_safety_violations(def_id).is_empty()
1856                         })
1857                 })
1858             }
1859         };
1860         if has_impl {
1861             if is_object_safe {
1862                 err.multipart_suggestion(
1863                     "you could change the return type to be a boxed trait object",
1864                     vec![
1865                         (return_sp.with_hi(return_sp.lo() + BytePos(4)), "Box<dyn".to_string()),
1866                         (return_sp.shrink_to_hi(), ">".to_string()),
1867                     ],
1868                     Applicability::MachineApplicable,
1869                 );
1870                 let sugg = [sp, cause.span]
1871                     .into_iter()
1872                     .flat_map(|sp| {
1873                         [
1874                             (sp.shrink_to_lo(), "Box::new(".to_string()),
1875                             (sp.shrink_to_hi(), ")".to_string()),
1876                         ]
1877                         .into_iter()
1878                     })
1879                     .collect::<Vec<_>>();
1880                 err.multipart_suggestion(
1881                     "if you change the return type to expect trait objects, box the returned \
1882                      expressions",
1883                     sugg,
1884                     Applicability::MaybeIncorrect,
1885                 );
1886             } else {
1887                 err.help(&format!(
1888                     "if the trait `{}` were object safe, you could return a boxed trait object",
1889                     &snippet[5..]
1890                 ));
1891             }
1892             err.note(trait_obj_msg);
1893         }
1894         err.help("you could instead create a new `enum` with a variant for each returned type");
1895     }
1896
1897     fn is_return_ty_unsized<'a>(&self, fcx: &FnCtxt<'a, 'tcx>, blk_id: hir::HirId) -> bool {
1898         if let Some((fn_decl, _)) = fcx.get_fn_decl(blk_id)
1899             && let hir::FnRetTy::Return(ty) = fn_decl.output
1900             && let ty = <dyn AstConv<'_>>::ast_ty_to_ty(fcx, ty)
1901             && let ty::Dynamic(..) = ty.kind()
1902         {
1903             return true;
1904         }
1905         false
1906     }
1907
1908     pub fn complete<'a>(self, fcx: &FnCtxt<'a, 'tcx>) -> Ty<'tcx> {
1909         if let Some(final_ty) = self.final_ty {
1910             final_ty
1911         } else {
1912             // If we only had inputs that were of type `!` (or no
1913             // inputs at all), then the final type is `!`.
1914             assert_eq!(self.pushed, 0);
1915             fcx.tcx.types.never
1916         }
1917     }
1918 }
1919
1920 /// Something that can be converted into an expression to which we can
1921 /// apply a coercion.
1922 pub trait AsCoercionSite {
1923     fn as_coercion_site(&self) -> &hir::Expr<'_>;
1924 }
1925
1926 impl AsCoercionSite for hir::Expr<'_> {
1927     fn as_coercion_site(&self) -> &hir::Expr<'_> {
1928         self
1929     }
1930 }
1931
1932 impl<'a, T> AsCoercionSite for &'a T
1933 where
1934     T: AsCoercionSite,
1935 {
1936     fn as_coercion_site(&self) -> &hir::Expr<'_> {
1937         (**self).as_coercion_site()
1938     }
1939 }
1940
1941 impl AsCoercionSite for ! {
1942     fn as_coercion_site(&self) -> &hir::Expr<'_> {
1943         unreachable!()
1944     }
1945 }
1946
1947 impl AsCoercionSite for hir::Arm<'_> {
1948     fn as_coercion_site(&self) -> &hir::Expr<'_> {
1949         &self.body
1950     }
1951 }