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