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