]> git.lizzy.rs Git - rust.git/blob - src/librustc_typeck/check/mod.rs
introduce PredicateAtom
[rust.git] / src / librustc_typeck / check / mod.rs
1 // ignore-tidy-filelength
2
3 /*!
4
5 # typeck: check phase
6
7 Within the check phase of type check, we check each item one at a time
8 (bodies of function expressions are checked as part of the containing
9 function). Inference is used to supply types wherever they are unknown.
10
11 By far the most complex case is checking the body of a function. This
12 can be broken down into several distinct phases:
13
14 - gather: creates type variables to represent the type of each local
15   variable and pattern binding.
16
17 - main: the main pass does the lion's share of the work: it
18   determines the types of all expressions, resolves
19   methods, checks for most invalid conditions, and so forth.  In
20   some cases, where a type is unknown, it may create a type or region
21   variable and use that as the type of an expression.
22
23   In the process of checking, various constraints will be placed on
24   these type variables through the subtyping relationships requested
25   through the `demand` module.  The `infer` module is in charge
26   of resolving those constraints.
27
28 - regionck: after main is complete, the regionck pass goes over all
29   types looking for regions and making sure that they did not escape
30   into places they are not in scope.  This may also influence the
31   final assignments of the various region variables if there is some
32   flexibility.
33
34 - writeback: writes the final types within a function body, replacing
35   type variables with their final inferred types.  These final types
36   are written into the `tcx.node_types` table, which should *never* contain
37   any reference to a type variable.
38
39 ## Intermediate types
40
41 While type checking a function, the intermediate types for the
42 expressions, blocks, and so forth contained within the function are
43 stored in `fcx.node_types` and `fcx.node_substs`.  These types
44 may contain unresolved type variables.  After type checking is
45 complete, the functions in the writeback module are used to take the
46 types from this table, resolve them, and then write them into their
47 permanent home in the type context `tcx`.
48
49 This means that during inferencing you should use `fcx.write_ty()`
50 and `fcx.expr_ty()` / `fcx.node_ty()` to write/obtain the types of
51 nodes within the function.
52
53 The types of top-level items, which never contain unbound type
54 variables, are stored directly into the `tcx` typeck_results.
55
56 N.B., a type variable is not the same thing as a type parameter.  A
57 type variable is rather an "instance" of a type parameter: that is,
58 given a generic function `fn foo<T>(t: T)`: while checking the
59 function `foo`, the type `ty_param(0)` refers to the type `T`, which
60 is treated in abstract.  When `foo()` is called, however, `T` will be
61 substituted for a fresh type variable `N`.  This variable will
62 eventually be resolved to some concrete type (which might itself be
63 type parameter).
64
65 */
66
67 pub mod _match;
68 mod autoderef;
69 mod callee;
70 mod cast;
71 mod closure;
72 pub mod coercion;
73 mod compare_method;
74 pub mod demand;
75 pub mod dropck;
76 mod expr;
77 mod generator_interior;
78 pub mod intrinsic;
79 pub mod method;
80 mod op;
81 mod pat;
82 mod place_op;
83 mod regionck;
84 mod upvar;
85 mod wfcheck;
86 pub mod writeback;
87
88 use crate::astconv::{
89     AstConv, ExplicitLateBound, GenericArgCountMismatch, GenericArgCountResult, PathSeg,
90 };
91 use rustc_ast::ast;
92 use rustc_ast::util::parser::ExprPrecedence;
93 use rustc_attr as attr;
94 use rustc_data_structures::captures::Captures;
95 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
96 use rustc_errors::ErrorReported;
97 use rustc_errors::{pluralize, struct_span_err, Applicability, DiagnosticBuilder, DiagnosticId};
98 use rustc_hir as hir;
99 use rustc_hir::def::{CtorOf, DefKind, Res};
100 use rustc_hir::def_id::{CrateNum, DefId, DefIdMap, LocalDefId, LOCAL_CRATE};
101 use rustc_hir::intravisit::{self, NestedVisitorMap, Visitor};
102 use rustc_hir::itemlikevisit::ItemLikeVisitor;
103 use rustc_hir::lang_items::{
104     FutureTraitLangItem, PinTypeLangItem, SizedTraitLangItem, VaListTypeLangItem,
105 };
106 use rustc_hir::{ExprKind, GenericArg, HirIdMap, ItemKind, Node, PatKind, QPath};
107 use rustc_index::bit_set::BitSet;
108 use rustc_index::vec::Idx;
109 use rustc_infer::infer;
110 use rustc_infer::infer::canonical::{Canonical, OriginalQueryValues, QueryResponse};
111 use rustc_infer::infer::error_reporting::TypeAnnotationNeeded::E0282;
112 use rustc_infer::infer::type_variable::{TypeVariableOrigin, TypeVariableOriginKind};
113 use rustc_infer::infer::unify_key::{ConstVariableOrigin, ConstVariableOriginKind};
114 use rustc_infer::infer::{InferCtxt, InferOk, InferResult, RegionVariableOrigin, TyCtxtInferExt};
115 use rustc_middle::hir::map::blocks::FnLikeNode;
116 use rustc_middle::mir::interpret::ConstValue;
117 use rustc_middle::ty::adjustment::{
118     Adjust, Adjustment, AllowTwoPhase, AutoBorrow, AutoBorrowMutability,
119 };
120 use rustc_middle::ty::fold::{TypeFoldable, TypeFolder};
121 use rustc_middle::ty::query::Providers;
122 use rustc_middle::ty::subst::{self, InternalSubsts, Subst, SubstsRef};
123 use rustc_middle::ty::subst::{GenericArgKind, UserSelfTy, UserSubsts};
124 use rustc_middle::ty::util::{Discr, IntTypeExt, Representability};
125 use rustc_middle::ty::{
126     self, AdtKind, CanonicalUserType, Const, GenericParamDefKind, RegionKind, ToPolyTraitRef,
127     ToPredicate, Ty, TyCtxt, UserType, WithConstness,
128 };
129 use rustc_session::config::{self, EntryFnType};
130 use rustc_session::lint;
131 use rustc_session::parse::feature_err;
132 use rustc_session::Session;
133 use rustc_span::hygiene::DesugaringKind;
134 use rustc_span::source_map::{original_sp, DUMMY_SP};
135 use rustc_span::symbol::{kw, sym, Ident};
136 use rustc_span::{self, BytePos, MultiSpan, Span};
137 use rustc_target::abi::VariantIdx;
138 use rustc_target::spec::abi::Abi;
139 use rustc_trait_selection::infer::InferCtxtExt as _;
140 use rustc_trait_selection::opaque_types::{InferCtxtExt as _, OpaqueTypeDecl};
141 use rustc_trait_selection::traits::error_reporting::recursive_type_with_infinite_size_error;
142 use rustc_trait_selection::traits::error_reporting::suggestions::ReturnsVisitor;
143 use rustc_trait_selection::traits::error_reporting::InferCtxtExt as _;
144 use rustc_trait_selection::traits::query::evaluate_obligation::InferCtxtExt as _;
145 use rustc_trait_selection::traits::{
146     self, ObligationCause, ObligationCauseCode, TraitEngine, TraitEngineExt,
147 };
148
149 use std::cell::{Cell, Ref, RefCell, RefMut};
150 use std::cmp;
151 use std::collections::hash_map::Entry;
152 use std::iter;
153 use std::mem::replace;
154 use std::ops::{self, Deref};
155 use std::slice;
156
157 use crate::require_c_abi_if_c_variadic;
158 use crate::util::common::indenter;
159
160 use self::callee::DeferredCallResolution;
161 use self::coercion::{CoerceMany, DynamicCoerceMany};
162 use self::compare_method::{compare_const_impl, compare_impl_method, compare_ty_impl};
163 use self::method::{MethodCallee, SelfSource};
164 pub use self::Expectation::*;
165 use self::TupleArgumentsFlag::*;
166
167 #[macro_export]
168 macro_rules! type_error_struct {
169     ($session:expr, $span:expr, $typ:expr, $code:ident, $($message:tt)*) => ({
170         if $typ.references_error() {
171             $session.diagnostic().struct_dummy()
172         } else {
173             rustc_errors::struct_span_err!($session, $span, $code, $($message)*)
174         }
175     })
176 }
177
178 /// The type of a local binding, including the revealed type for anon types.
179 #[derive(Copy, Clone, Debug)]
180 pub struct LocalTy<'tcx> {
181     decl_ty: Ty<'tcx>,
182     revealed_ty: Ty<'tcx>,
183 }
184
185 /// A wrapper for `InferCtxt`'s `in_progress_typeck_results` field.
186 #[derive(Copy, Clone)]
187 struct MaybeInProgressTables<'a, 'tcx> {
188     maybe_typeck_results: Option<&'a RefCell<ty::TypeckResults<'tcx>>>,
189 }
190
191 impl<'a, 'tcx> MaybeInProgressTables<'a, 'tcx> {
192     fn borrow(self) -> Ref<'a, ty::TypeckResults<'tcx>> {
193         match self.maybe_typeck_results {
194             Some(typeck_results) => typeck_results.borrow(),
195             None => bug!(
196                 "MaybeInProgressTables: inh/fcx.typeck_results.borrow() with no typeck results"
197             ),
198         }
199     }
200
201     fn borrow_mut(self) -> RefMut<'a, ty::TypeckResults<'tcx>> {
202         match self.maybe_typeck_results {
203             Some(typeck_results) => typeck_results.borrow_mut(),
204             None => bug!(
205                 "MaybeInProgressTables: inh/fcx.typeck_results.borrow_mut() with no typeck results"
206             ),
207         }
208     }
209 }
210
211 /// Closures defined within the function. For example:
212 ///
213 ///     fn foo() {
214 ///         bar(move|| { ... })
215 ///     }
216 ///
217 /// Here, the function `foo()` and the closure passed to
218 /// `bar()` will each have their own `FnCtxt`, but they will
219 /// share the inherited fields.
220 pub struct Inherited<'a, 'tcx> {
221     infcx: InferCtxt<'a, 'tcx>,
222
223     typeck_results: MaybeInProgressTables<'a, 'tcx>,
224
225     locals: RefCell<HirIdMap<LocalTy<'tcx>>>,
226
227     fulfillment_cx: RefCell<Box<dyn TraitEngine<'tcx>>>,
228
229     // Some additional `Sized` obligations badly affect type inference.
230     // These obligations are added in a later stage of typeck.
231     deferred_sized_obligations: RefCell<Vec<(Ty<'tcx>, Span, traits::ObligationCauseCode<'tcx>)>>,
232
233     // When we process a call like `c()` where `c` is a closure type,
234     // we may not have decided yet whether `c` is a `Fn`, `FnMut`, or
235     // `FnOnce` closure. In that case, we defer full resolution of the
236     // call until upvar inference can kick in and make the
237     // decision. We keep these deferred resolutions grouped by the
238     // def-id of the closure, so that once we decide, we can easily go
239     // back and process them.
240     deferred_call_resolutions: RefCell<DefIdMap<Vec<DeferredCallResolution<'tcx>>>>,
241
242     deferred_cast_checks: RefCell<Vec<cast::CastCheck<'tcx>>>,
243
244     deferred_generator_interiors: RefCell<Vec<(hir::BodyId, Ty<'tcx>, hir::GeneratorKind)>>,
245
246     // Opaque types found in explicit return types and their
247     // associated fresh inference variable. Writeback resolves these
248     // variables to get the concrete type, which can be used to
249     // 'de-opaque' OpaqueTypeDecl, after typeck is done with all functions.
250     opaque_types: RefCell<DefIdMap<OpaqueTypeDecl<'tcx>>>,
251
252     /// A map from inference variables created from opaque
253     /// type instantiations (`ty::Infer`) to the actual opaque
254     /// type (`ty::Opaque`). Used during fallback to map unconstrained
255     /// opaque type inference variables to their corresponding
256     /// opaque type.
257     opaque_types_vars: RefCell<FxHashMap<Ty<'tcx>, Ty<'tcx>>>,
258
259     body_id: Option<hir::BodyId>,
260 }
261
262 impl<'a, 'tcx> Deref for Inherited<'a, 'tcx> {
263     type Target = InferCtxt<'a, 'tcx>;
264     fn deref(&self) -> &Self::Target {
265         &self.infcx
266     }
267 }
268
269 /// When type-checking an expression, we propagate downward
270 /// whatever type hint we are able in the form of an `Expectation`.
271 #[derive(Copy, Clone, Debug)]
272 pub enum Expectation<'tcx> {
273     /// We know nothing about what type this expression should have.
274     NoExpectation,
275
276     /// This expression should have the type given (or some subtype).
277     ExpectHasType(Ty<'tcx>),
278
279     /// This expression will be cast to the `Ty`.
280     ExpectCastableToType(Ty<'tcx>),
281
282     /// This rvalue expression will be wrapped in `&` or `Box` and coerced
283     /// to `&Ty` or `Box<Ty>`, respectively. `Ty` is `[A]` or `Trait`.
284     ExpectRvalueLikeUnsized(Ty<'tcx>),
285 }
286
287 impl<'a, 'tcx> Expectation<'tcx> {
288     // Disregard "castable to" expectations because they
289     // can lead us astray. Consider for example `if cond
290     // {22} else {c} as u8` -- if we propagate the
291     // "castable to u8" constraint to 22, it will pick the
292     // type 22u8, which is overly constrained (c might not
293     // be a u8). In effect, the problem is that the
294     // "castable to" expectation is not the tightest thing
295     // we can say, so we want to drop it in this case.
296     // The tightest thing we can say is "must unify with
297     // else branch". Note that in the case of a "has type"
298     // constraint, this limitation does not hold.
299
300     // If the expected type is just a type variable, then don't use
301     // an expected type. Otherwise, we might write parts of the type
302     // when checking the 'then' block which are incompatible with the
303     // 'else' branch.
304     fn adjust_for_branches(&self, fcx: &FnCtxt<'a, 'tcx>) -> Expectation<'tcx> {
305         match *self {
306             ExpectHasType(ety) => {
307                 let ety = fcx.shallow_resolve(ety);
308                 if !ety.is_ty_var() { ExpectHasType(ety) } else { NoExpectation }
309             }
310             ExpectRvalueLikeUnsized(ety) => ExpectRvalueLikeUnsized(ety),
311             _ => NoExpectation,
312         }
313     }
314
315     /// Provides an expectation for an rvalue expression given an *optional*
316     /// hint, which is not required for type safety (the resulting type might
317     /// be checked higher up, as is the case with `&expr` and `box expr`), but
318     /// is useful in determining the concrete type.
319     ///
320     /// The primary use case is where the expected type is a fat pointer,
321     /// like `&[isize]`. For example, consider the following statement:
322     ///
323     ///    let x: &[isize] = &[1, 2, 3];
324     ///
325     /// In this case, the expected type for the `&[1, 2, 3]` expression is
326     /// `&[isize]`. If however we were to say that `[1, 2, 3]` has the
327     /// expectation `ExpectHasType([isize])`, that would be too strong --
328     /// `[1, 2, 3]` does not have the type `[isize]` but rather `[isize; 3]`.
329     /// It is only the `&[1, 2, 3]` expression as a whole that can be coerced
330     /// to the type `&[isize]`. Therefore, we propagate this more limited hint,
331     /// which still is useful, because it informs integer literals and the like.
332     /// See the test case `test/ui/coerce-expect-unsized.rs` and #20169
333     /// for examples of where this comes up,.
334     fn rvalue_hint(fcx: &FnCtxt<'a, 'tcx>, ty: Ty<'tcx>) -> Expectation<'tcx> {
335         match fcx.tcx.struct_tail_without_normalization(ty).kind {
336             ty::Slice(_) | ty::Str | ty::Dynamic(..) => ExpectRvalueLikeUnsized(ty),
337             _ => ExpectHasType(ty),
338         }
339     }
340
341     // Resolves `expected` by a single level if it is a variable. If
342     // there is no expected type or resolution is not possible (e.g.,
343     // no constraints yet present), just returns `None`.
344     fn resolve(self, fcx: &FnCtxt<'a, 'tcx>) -> Expectation<'tcx> {
345         match self {
346             NoExpectation => NoExpectation,
347             ExpectCastableToType(t) => ExpectCastableToType(fcx.resolve_vars_if_possible(&t)),
348             ExpectHasType(t) => ExpectHasType(fcx.resolve_vars_if_possible(&t)),
349             ExpectRvalueLikeUnsized(t) => ExpectRvalueLikeUnsized(fcx.resolve_vars_if_possible(&t)),
350         }
351     }
352
353     fn to_option(self, fcx: &FnCtxt<'a, 'tcx>) -> Option<Ty<'tcx>> {
354         match self.resolve(fcx) {
355             NoExpectation => None,
356             ExpectCastableToType(ty) | ExpectHasType(ty) | ExpectRvalueLikeUnsized(ty) => Some(ty),
357         }
358     }
359
360     /// It sometimes happens that we want to turn an expectation into
361     /// a **hard constraint** (i.e., something that must be satisfied
362     /// for the program to type-check). `only_has_type` will return
363     /// such a constraint, if it exists.
364     fn only_has_type(self, fcx: &FnCtxt<'a, 'tcx>) -> Option<Ty<'tcx>> {
365         match self.resolve(fcx) {
366             ExpectHasType(ty) => Some(ty),
367             NoExpectation | ExpectCastableToType(_) | ExpectRvalueLikeUnsized(_) => None,
368         }
369     }
370
371     /// Like `only_has_type`, but instead of returning `None` if no
372     /// hard constraint exists, creates a fresh type variable.
373     fn coercion_target_type(self, fcx: &FnCtxt<'a, 'tcx>, span: Span) -> Ty<'tcx> {
374         self.only_has_type(fcx).unwrap_or_else(|| {
375             fcx.next_ty_var(TypeVariableOrigin { kind: TypeVariableOriginKind::MiscVariable, span })
376         })
377     }
378 }
379
380 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
381 pub enum Needs {
382     MutPlace,
383     None,
384 }
385
386 impl Needs {
387     fn maybe_mut_place(m: hir::Mutability) -> Self {
388         match m {
389             hir::Mutability::Mut => Needs::MutPlace,
390             hir::Mutability::Not => Needs::None,
391         }
392     }
393 }
394
395 #[derive(Copy, Clone)]
396 pub struct UnsafetyState {
397     pub def: hir::HirId,
398     pub unsafety: hir::Unsafety,
399     pub unsafe_push_count: u32,
400     from_fn: bool,
401 }
402
403 impl UnsafetyState {
404     pub fn function(unsafety: hir::Unsafety, def: hir::HirId) -> UnsafetyState {
405         UnsafetyState { def, unsafety, unsafe_push_count: 0, from_fn: true }
406     }
407
408     pub fn recurse(&mut self, blk: &hir::Block<'_>) -> UnsafetyState {
409         use hir::BlockCheckMode;
410         match self.unsafety {
411             // If this unsafe, then if the outer function was already marked as
412             // unsafe we shouldn't attribute the unsafe'ness to the block. This
413             // way the block can be warned about instead of ignoring this
414             // extraneous block (functions are never warned about).
415             hir::Unsafety::Unsafe if self.from_fn => *self,
416
417             unsafety => {
418                 let (unsafety, def, count) = match blk.rules {
419                     BlockCheckMode::PushUnsafeBlock(..) => {
420                         (unsafety, blk.hir_id, self.unsafe_push_count.checked_add(1).unwrap())
421                     }
422                     BlockCheckMode::PopUnsafeBlock(..) => {
423                         (unsafety, blk.hir_id, self.unsafe_push_count.checked_sub(1).unwrap())
424                     }
425                     BlockCheckMode::UnsafeBlock(..) => {
426                         (hir::Unsafety::Unsafe, blk.hir_id, self.unsafe_push_count)
427                     }
428                     BlockCheckMode::DefaultBlock => (unsafety, self.def, self.unsafe_push_count),
429                 };
430                 UnsafetyState { def, unsafety, unsafe_push_count: count, from_fn: false }
431             }
432         }
433     }
434 }
435
436 #[derive(Debug, Copy, Clone)]
437 pub enum PlaceOp {
438     Deref,
439     Index,
440 }
441
442 /// Tracks whether executing a node may exit normally (versus
443 /// return/break/panic, which "diverge", leaving dead code in their
444 /// wake). Tracked semi-automatically (through type variables marked
445 /// as diverging), with some manual adjustments for control-flow
446 /// primitives (approximating a CFG).
447 #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
448 pub enum Diverges {
449     /// Potentially unknown, some cases converge,
450     /// others require a CFG to determine them.
451     Maybe,
452
453     /// Definitely known to diverge and therefore
454     /// not reach the next sibling or its parent.
455     Always {
456         /// The `Span` points to the expression
457         /// that caused us to diverge
458         /// (e.g. `return`, `break`, etc).
459         span: Span,
460         /// In some cases (e.g. a `match` expression
461         /// where all arms diverge), we may be
462         /// able to provide a more informative
463         /// message to the user.
464         /// If this is `None`, a default message
465         /// will be generated, which is suitable
466         /// for most cases.
467         custom_note: Option<&'static str>,
468     },
469
470     /// Same as `Always` but with a reachability
471     /// warning already emitted.
472     WarnedAlways,
473 }
474
475 // Convenience impls for combining `Diverges`.
476
477 impl ops::BitAnd for Diverges {
478     type Output = Self;
479     fn bitand(self, other: Self) -> Self {
480         cmp::min(self, other)
481     }
482 }
483
484 impl ops::BitOr for Diverges {
485     type Output = Self;
486     fn bitor(self, other: Self) -> Self {
487         cmp::max(self, other)
488     }
489 }
490
491 impl ops::BitAndAssign for Diverges {
492     fn bitand_assign(&mut self, other: Self) {
493         *self = *self & other;
494     }
495 }
496
497 impl ops::BitOrAssign for Diverges {
498     fn bitor_assign(&mut self, other: Self) {
499         *self = *self | other;
500     }
501 }
502
503 impl Diverges {
504     /// Creates a `Diverges::Always` with the provided `span` and the default note message.
505     fn always(span: Span) -> Diverges {
506         Diverges::Always { span, custom_note: None }
507     }
508
509     fn is_always(self) -> bool {
510         // Enum comparison ignores the
511         // contents of fields, so we just
512         // fill them in with garbage here.
513         self >= Diverges::Always { span: DUMMY_SP, custom_note: None }
514     }
515 }
516
517 pub struct BreakableCtxt<'tcx> {
518     may_break: bool,
519
520     // this is `null` for loops where break with a value is illegal,
521     // such as `while`, `for`, and `while let`
522     coerce: Option<DynamicCoerceMany<'tcx>>,
523 }
524
525 pub struct EnclosingBreakables<'tcx> {
526     stack: Vec<BreakableCtxt<'tcx>>,
527     by_id: HirIdMap<usize>,
528 }
529
530 impl<'tcx> EnclosingBreakables<'tcx> {
531     fn find_breakable(&mut self, target_id: hir::HirId) -> &mut BreakableCtxt<'tcx> {
532         self.opt_find_breakable(target_id).unwrap_or_else(|| {
533             bug!("could not find enclosing breakable with id {}", target_id);
534         })
535     }
536
537     fn opt_find_breakable(&mut self, target_id: hir::HirId) -> Option<&mut BreakableCtxt<'tcx>> {
538         match self.by_id.get(&target_id) {
539             Some(ix) => Some(&mut self.stack[*ix]),
540             None => None,
541         }
542     }
543 }
544
545 pub struct FnCtxt<'a, 'tcx> {
546     body_id: hir::HirId,
547
548     /// The parameter environment used for proving trait obligations
549     /// in this function. This can change when we descend into
550     /// closures (as they bring new things into scope), hence it is
551     /// not part of `Inherited` (as of the time of this writing,
552     /// closures do not yet change the environment, but they will
553     /// eventually).
554     param_env: ty::ParamEnv<'tcx>,
555
556     /// Number of errors that had been reported when we started
557     /// checking this function. On exit, if we find that *more* errors
558     /// have been reported, we will skip regionck and other work that
559     /// expects the types within the function to be consistent.
560     // FIXME(matthewjasper) This should not exist, and it's not correct
561     // if type checking is run in parallel.
562     err_count_on_creation: usize,
563
564     /// If `Some`, this stores coercion information for returned
565     /// expressions. If `None`, this is in a context where return is
566     /// inappropriate, such as a const expression.
567     ///
568     /// This is a `RefCell<DynamicCoerceMany>`, which means that we
569     /// can track all the return expressions and then use them to
570     /// compute a useful coercion from the set, similar to a match
571     /// expression or other branching context. You can use methods
572     /// like `expected_ty` to access the declared return type (if
573     /// any).
574     ret_coercion: Option<RefCell<DynamicCoerceMany<'tcx>>>,
575
576     /// First span of a return site that we find. Used in error messages.
577     ret_coercion_span: RefCell<Option<Span>>,
578
579     resume_yield_tys: Option<(Ty<'tcx>, Ty<'tcx>)>,
580
581     ps: RefCell<UnsafetyState>,
582
583     /// Whether the last checked node generates a divergence (e.g.,
584     /// `return` will set this to `Always`). In general, when entering
585     /// an expression or other node in the tree, the initial value
586     /// indicates whether prior parts of the containing expression may
587     /// have diverged. It is then typically set to `Maybe` (and the
588     /// old value remembered) for processing the subparts of the
589     /// current expression. As each subpart is processed, they may set
590     /// the flag to `Always`, etc. Finally, at the end, we take the
591     /// result and "union" it with the original value, so that when we
592     /// return the flag indicates if any subpart of the parent
593     /// expression (up to and including this part) has diverged. So,
594     /// if you read it after evaluating a subexpression `X`, the value
595     /// you get indicates whether any subexpression that was
596     /// evaluating up to and including `X` diverged.
597     ///
598     /// We currently use this flag only for diagnostic purposes:
599     ///
600     /// - To warn about unreachable code: if, after processing a
601     ///   sub-expression but before we have applied the effects of the
602     ///   current node, we see that the flag is set to `Always`, we
603     ///   can issue a warning. This corresponds to something like
604     ///   `foo(return)`; we warn on the `foo()` expression. (We then
605     ///   update the flag to `WarnedAlways` to suppress duplicate
606     ///   reports.) Similarly, if we traverse to a fresh statement (or
607     ///   tail expression) from a `Always` setting, we will issue a
608     ///   warning. This corresponds to something like `{return;
609     ///   foo();}` or `{return; 22}`, where we would warn on the
610     ///   `foo()` or `22`.
611     ///
612     /// An expression represents dead code if, after checking it,
613     /// the diverges flag is set to something other than `Maybe`.
614     diverges: Cell<Diverges>,
615
616     /// Whether any child nodes have any type errors.
617     has_errors: Cell<bool>,
618
619     enclosing_breakables: RefCell<EnclosingBreakables<'tcx>>,
620
621     inh: &'a Inherited<'a, 'tcx>,
622 }
623
624 impl<'a, 'tcx> Deref for FnCtxt<'a, 'tcx> {
625     type Target = Inherited<'a, 'tcx>;
626     fn deref(&self) -> &Self::Target {
627         &self.inh
628     }
629 }
630
631 /// Helper type of a temporary returned by `Inherited::build(...)`.
632 /// Necessary because we can't write the following bound:
633 /// `F: for<'b, 'tcx> where 'tcx FnOnce(Inherited<'b, 'tcx>)`.
634 pub struct InheritedBuilder<'tcx> {
635     infcx: infer::InferCtxtBuilder<'tcx>,
636     def_id: LocalDefId,
637 }
638
639 impl Inherited<'_, 'tcx> {
640     pub fn build(tcx: TyCtxt<'tcx>, def_id: LocalDefId) -> InheritedBuilder<'tcx> {
641         let hir_owner = tcx.hir().local_def_id_to_hir_id(def_id).owner;
642
643         InheritedBuilder {
644             infcx: tcx.infer_ctxt().with_fresh_in_progress_typeck_results(hir_owner),
645             def_id,
646         }
647     }
648 }
649
650 impl<'tcx> InheritedBuilder<'tcx> {
651     fn enter<F, R>(&mut self, f: F) -> R
652     where
653         F: for<'a> FnOnce(Inherited<'a, 'tcx>) -> R,
654     {
655         let def_id = self.def_id;
656         self.infcx.enter(|infcx| f(Inherited::new(infcx, def_id)))
657     }
658 }
659
660 impl Inherited<'a, 'tcx> {
661     fn new(infcx: InferCtxt<'a, 'tcx>, def_id: LocalDefId) -> Self {
662         let tcx = infcx.tcx;
663         let item_id = tcx.hir().local_def_id_to_hir_id(def_id);
664         let body_id = tcx.hir().maybe_body_owned_by(item_id);
665
666         Inherited {
667             typeck_results: MaybeInProgressTables {
668                 maybe_typeck_results: infcx.in_progress_typeck_results,
669             },
670             infcx,
671             fulfillment_cx: RefCell::new(TraitEngine::new(tcx)),
672             locals: RefCell::new(Default::default()),
673             deferred_sized_obligations: RefCell::new(Vec::new()),
674             deferred_call_resolutions: RefCell::new(Default::default()),
675             deferred_cast_checks: RefCell::new(Vec::new()),
676             deferred_generator_interiors: RefCell::new(Vec::new()),
677             opaque_types: RefCell::new(Default::default()),
678             opaque_types_vars: RefCell::new(Default::default()),
679             body_id,
680         }
681     }
682
683     fn register_predicate(&self, obligation: traits::PredicateObligation<'tcx>) {
684         debug!("register_predicate({:?})", obligation);
685         if obligation.has_escaping_bound_vars() {
686             span_bug!(obligation.cause.span, "escaping bound vars in predicate {:?}", obligation);
687         }
688         self.fulfillment_cx.borrow_mut().register_predicate_obligation(self, obligation);
689     }
690
691     fn register_predicates<I>(&self, obligations: I)
692     where
693         I: IntoIterator<Item = traits::PredicateObligation<'tcx>>,
694     {
695         for obligation in obligations {
696             self.register_predicate(obligation);
697         }
698     }
699
700     fn register_infer_ok_obligations<T>(&self, infer_ok: InferOk<'tcx, T>) -> T {
701         self.register_predicates(infer_ok.obligations);
702         infer_ok.value
703     }
704
705     fn normalize_associated_types_in<T>(
706         &self,
707         span: Span,
708         body_id: hir::HirId,
709         param_env: ty::ParamEnv<'tcx>,
710         value: &T,
711     ) -> T
712     where
713         T: TypeFoldable<'tcx>,
714     {
715         let ok = self.partially_normalize_associated_types_in(span, body_id, param_env, value);
716         self.register_infer_ok_obligations(ok)
717     }
718 }
719
720 struct CheckItemTypesVisitor<'tcx> {
721     tcx: TyCtxt<'tcx>,
722 }
723
724 impl ItemLikeVisitor<'tcx> for CheckItemTypesVisitor<'tcx> {
725     fn visit_item(&mut self, i: &'tcx hir::Item<'tcx>) {
726         check_item_type(self.tcx, i);
727     }
728     fn visit_trait_item(&mut self, _: &'tcx hir::TraitItem<'tcx>) {}
729     fn visit_impl_item(&mut self, _: &'tcx hir::ImplItem<'tcx>) {}
730 }
731
732 pub fn check_wf_new(tcx: TyCtxt<'_>) {
733     let visit = wfcheck::CheckTypeWellFormedVisitor::new(tcx);
734     tcx.hir().krate().par_visit_all_item_likes(&visit);
735 }
736
737 fn check_mod_item_types(tcx: TyCtxt<'_>, module_def_id: LocalDefId) {
738     tcx.hir().visit_item_likes_in_module(module_def_id, &mut CheckItemTypesVisitor { tcx });
739 }
740
741 fn typeck_item_bodies(tcx: TyCtxt<'_>, crate_num: CrateNum) {
742     debug_assert!(crate_num == LOCAL_CRATE);
743     tcx.par_body_owners(|body_owner_def_id| {
744         tcx.ensure().typeck(body_owner_def_id);
745     });
746 }
747
748 fn check_item_well_formed(tcx: TyCtxt<'_>, def_id: LocalDefId) {
749     wfcheck::check_item_well_formed(tcx, def_id);
750 }
751
752 fn check_trait_item_well_formed(tcx: TyCtxt<'_>, def_id: LocalDefId) {
753     wfcheck::check_trait_item(tcx, def_id);
754 }
755
756 fn check_impl_item_well_formed(tcx: TyCtxt<'_>, def_id: LocalDefId) {
757     wfcheck::check_impl_item(tcx, def_id);
758 }
759
760 pub fn provide(providers: &mut Providers) {
761     method::provide(providers);
762     *providers = Providers {
763         typeck_item_bodies,
764         typeck_const_arg,
765         typeck,
766         diagnostic_only_typeck,
767         has_typeck_results,
768         adt_destructor,
769         used_trait_imports,
770         check_item_well_formed,
771         check_trait_item_well_formed,
772         check_impl_item_well_formed,
773         check_mod_item_types,
774         ..*providers
775     };
776 }
777
778 fn adt_destructor(tcx: TyCtxt<'_>, def_id: DefId) -> Option<ty::Destructor> {
779     tcx.calculate_dtor(def_id, &mut dropck::check_drop_impl)
780 }
781
782 /// If this `DefId` is a "primary tables entry", returns
783 /// `Some((body_id, header, decl))` with information about
784 /// it's body-id, fn-header and fn-decl (if any). Otherwise,
785 /// returns `None`.
786 ///
787 /// If this function returns `Some`, then `typeck_results(def_id)` will
788 /// succeed; if it returns `None`, then `typeck_results(def_id)` may or
789 /// may not succeed. In some cases where this function returns `None`
790 /// (notably closures), `typeck_results(def_id)` would wind up
791 /// redirecting to the owning function.
792 fn primary_body_of(
793     tcx: TyCtxt<'_>,
794     id: hir::HirId,
795 ) -> Option<(hir::BodyId, Option<&hir::Ty<'_>>, Option<&hir::FnHeader>, Option<&hir::FnDecl<'_>>)> {
796     match tcx.hir().get(id) {
797         Node::Item(item) => match item.kind {
798             hir::ItemKind::Const(ref ty, body) | hir::ItemKind::Static(ref ty, _, body) => {
799                 Some((body, Some(ty), None, None))
800             }
801             hir::ItemKind::Fn(ref sig, .., body) => {
802                 Some((body, None, Some(&sig.header), Some(&sig.decl)))
803             }
804             _ => None,
805         },
806         Node::TraitItem(item) => match item.kind {
807             hir::TraitItemKind::Const(ref ty, Some(body)) => Some((body, Some(ty), None, None)),
808             hir::TraitItemKind::Fn(ref sig, hir::TraitFn::Provided(body)) => {
809                 Some((body, None, Some(&sig.header), Some(&sig.decl)))
810             }
811             _ => None,
812         },
813         Node::ImplItem(item) => match item.kind {
814             hir::ImplItemKind::Const(ref ty, body) => Some((body, Some(ty), None, None)),
815             hir::ImplItemKind::Fn(ref sig, body) => {
816                 Some((body, None, Some(&sig.header), Some(&sig.decl)))
817             }
818             _ => None,
819         },
820         Node::AnonConst(constant) => Some((constant.body, None, None, None)),
821         _ => None,
822     }
823 }
824
825 fn has_typeck_results(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
826     // Closures' typeck results come from their outermost function,
827     // as they are part of the same "inference environment".
828     let outer_def_id = tcx.closure_base_def_id(def_id);
829     if outer_def_id != def_id {
830         return tcx.has_typeck_results(outer_def_id);
831     }
832
833     if let Some(def_id) = def_id.as_local() {
834         let id = tcx.hir().local_def_id_to_hir_id(def_id);
835         primary_body_of(tcx, id).is_some()
836     } else {
837         false
838     }
839 }
840
841 fn used_trait_imports(tcx: TyCtxt<'_>, def_id: LocalDefId) -> &FxHashSet<LocalDefId> {
842     &*tcx.typeck(def_id).used_trait_imports
843 }
844
845 /// Inspects the substs of opaque types, replacing any inference variables
846 /// with proper generic parameter from the identity substs.
847 ///
848 /// This is run after we normalize the function signature, to fix any inference
849 /// variables introduced by the projection of associated types. This ensures that
850 /// any opaque types used in the signature continue to refer to generic parameters,
851 /// allowing them to be considered for defining uses in the function body
852 ///
853 /// For example, consider this code.
854 ///
855 /// ```rust
856 /// trait MyTrait {
857 ///     type MyItem;
858 ///     fn use_it(self) -> Self::MyItem
859 /// }
860 /// impl<T, I> MyTrait for T where T: Iterator<Item = I> {
861 ///     type MyItem = impl Iterator<Item = I>;
862 ///     fn use_it(self) -> Self::MyItem {
863 ///         self
864 ///     }
865 /// }
866 /// ```
867 ///
868 /// When we normalize the signature of `use_it` from the impl block,
869 /// we will normalize `Self::MyItem` to the opaque type `impl Iterator<Item = I>`
870 /// However, this projection result may contain inference variables, due
871 /// to the way that projection works. We didn't have any inference variables
872 /// in the signature to begin with - leaving them in will cause us to incorrectly
873 /// conclude that we don't have a defining use of `MyItem`. By mapping inference
874 /// variables back to the actual generic parameters, we will correctly see that
875 /// we have a defining use of `MyItem`
876 fn fixup_opaque_types<'tcx, T>(tcx: TyCtxt<'tcx>, val: &T) -> T
877 where
878     T: TypeFoldable<'tcx>,
879 {
880     struct FixupFolder<'tcx> {
881         tcx: TyCtxt<'tcx>,
882     }
883
884     impl<'tcx> TypeFolder<'tcx> for FixupFolder<'tcx> {
885         fn tcx<'a>(&'a self) -> TyCtxt<'tcx> {
886             self.tcx
887         }
888
889         fn fold_ty(&mut self, ty: Ty<'tcx>) -> Ty<'tcx> {
890             match ty.kind {
891                 ty::Opaque(def_id, substs) => {
892                     debug!("fixup_opaque_types: found type {:?}", ty);
893                     // Here, we replace any inference variables that occur within
894                     // the substs of an opaque type. By definition, any type occurring
895                     // in the substs has a corresponding generic parameter, which is what
896                     // we replace it with.
897                     // This replacement is only run on the function signature, so any
898                     // inference variables that we come across must be the rust of projection
899                     // (there's no other way for a user to get inference variables into
900                     // a function signature).
901                     if ty.needs_infer() {
902                         let new_substs = InternalSubsts::for_item(self.tcx, def_id, |param, _| {
903                             let old_param = substs[param.index as usize];
904                             match old_param.unpack() {
905                                 GenericArgKind::Type(old_ty) => {
906                                     if let ty::Infer(_) = old_ty.kind {
907                                         // Replace inference type with a generic parameter
908                                         self.tcx.mk_param_from_def(param)
909                                     } else {
910                                         old_param.fold_with(self)
911                                     }
912                                 }
913                                 GenericArgKind::Const(old_const) => {
914                                     if let ty::ConstKind::Infer(_) = old_const.val {
915                                         // This should never happen - we currently do not support
916                                         // 'const projections', e.g.:
917                                         // `impl<T: SomeTrait> MyTrait for T where <T as SomeTrait>::MyConst == 25`
918                                         // which should be the only way for us to end up with a const inference
919                                         // variable after projection. If Rust ever gains support for this kind
920                                         // of projection, this should *probably* be changed to
921                                         // `self.tcx.mk_param_from_def(param)`
922                                         bug!(
923                                             "Found infer const: `{:?}` in opaque type: {:?}",
924                                             old_const,
925                                             ty
926                                         );
927                                     } else {
928                                         old_param.fold_with(self)
929                                     }
930                                 }
931                                 GenericArgKind::Lifetime(old_region) => {
932                                     if let RegionKind::ReVar(_) = old_region {
933                                         self.tcx.mk_param_from_def(param)
934                                     } else {
935                                         old_param.fold_with(self)
936                                     }
937                                 }
938                             }
939                         });
940                         let new_ty = self.tcx.mk_opaque(def_id, new_substs);
941                         debug!("fixup_opaque_types: new type: {:?}", new_ty);
942                         new_ty
943                     } else {
944                         ty
945                     }
946                 }
947                 _ => ty.super_fold_with(self),
948             }
949         }
950     }
951
952     debug!("fixup_opaque_types({:?})", val);
953     val.fold_with(&mut FixupFolder { tcx })
954 }
955
956 fn typeck_const_arg<'tcx>(
957     tcx: TyCtxt<'tcx>,
958     (did, param_did): (LocalDefId, DefId),
959 ) -> &ty::TypeckResults<'tcx> {
960     let fallback = move || tcx.type_of(param_did);
961     typeck_with_fallback(tcx, did, fallback)
962 }
963
964 fn typeck<'tcx>(tcx: TyCtxt<'tcx>, def_id: LocalDefId) -> &ty::TypeckResults<'tcx> {
965     if let Some(param_did) = tcx.opt_const_param_of(def_id) {
966         tcx.typeck_const_arg((def_id, param_did))
967     } else {
968         let fallback = move || tcx.type_of(def_id.to_def_id());
969         typeck_with_fallback(tcx, def_id, fallback)
970     }
971 }
972
973 /// Used only to get `TypeckResults` for type inference during error recovery.
974 /// Currently only used for type inference of `static`s and `const`s to avoid type cycle errors.
975 fn diagnostic_only_typeck<'tcx>(tcx: TyCtxt<'tcx>, def_id: LocalDefId) -> &ty::TypeckResults<'tcx> {
976     let fallback = move || {
977         let span = tcx.hir().span(tcx.hir().as_local_hir_id(def_id));
978         tcx.ty_error_with_message(span, "diagnostic only typeck table used")
979     };
980     typeck_with_fallback(tcx, def_id, fallback)
981 }
982
983 fn typeck_with_fallback<'tcx>(
984     tcx: TyCtxt<'tcx>,
985     def_id: LocalDefId,
986     fallback: impl Fn() -> Ty<'tcx> + 'tcx,
987 ) -> &'tcx ty::TypeckResults<'tcx> {
988     // Closures' typeck results come from their outermost function,
989     // as they are part of the same "inference environment".
990     let outer_def_id = tcx.closure_base_def_id(def_id.to_def_id()).expect_local();
991     if outer_def_id != def_id {
992         return tcx.typeck(outer_def_id);
993     }
994
995     let id = tcx.hir().as_local_hir_id(def_id);
996     let span = tcx.hir().span(id);
997
998     // Figure out what primary body this item has.
999     let (body_id, body_ty, fn_header, fn_decl) = primary_body_of(tcx, id).unwrap_or_else(|| {
1000         span_bug!(span, "can't type-check body of {:?}", def_id);
1001     });
1002     let body = tcx.hir().body(body_id);
1003
1004     let typeck_results = Inherited::build(tcx, def_id).enter(|inh| {
1005         let param_env = tcx.param_env(def_id);
1006         let fcx = if let (Some(header), Some(decl)) = (fn_header, fn_decl) {
1007             let fn_sig = if crate::collect::get_infer_ret_ty(&decl.output).is_some() {
1008                 let fcx = FnCtxt::new(&inh, param_env, body.value.hir_id);
1009                 AstConv::ty_of_fn(
1010                     &fcx,
1011                     header.unsafety,
1012                     header.abi,
1013                     decl,
1014                     &hir::Generics::empty(),
1015                     None,
1016                 )
1017             } else {
1018                 tcx.fn_sig(def_id)
1019             };
1020
1021             check_abi(tcx, span, fn_sig.abi());
1022
1023             // Compute the fty from point of view of inside the fn.
1024             let fn_sig = tcx.liberate_late_bound_regions(def_id.to_def_id(), &fn_sig);
1025             let fn_sig = inh.normalize_associated_types_in(
1026                 body.value.span,
1027                 body_id.hir_id,
1028                 param_env,
1029                 &fn_sig,
1030             );
1031
1032             let fn_sig = fixup_opaque_types(tcx, &fn_sig);
1033
1034             let fcx = check_fn(&inh, param_env, fn_sig, decl, id, body, None).0;
1035             fcx
1036         } else {
1037             let fcx = FnCtxt::new(&inh, param_env, body.value.hir_id);
1038             let expected_type = body_ty
1039                 .and_then(|ty| match ty.kind {
1040                     hir::TyKind::Infer => Some(AstConv::ast_ty_to_ty(&fcx, ty)),
1041                     _ => None,
1042                 })
1043                 .unwrap_or_else(fallback);
1044             let expected_type = fcx.normalize_associated_types_in(body.value.span, &expected_type);
1045             fcx.require_type_is_sized(expected_type, body.value.span, traits::ConstSized);
1046
1047             let revealed_ty = if tcx.features().impl_trait_in_bindings {
1048                 fcx.instantiate_opaque_types_from_value(id, &expected_type, body.value.span)
1049             } else {
1050                 expected_type
1051             };
1052
1053             // Gather locals in statics (because of block expressions).
1054             GatherLocalsVisitor { fcx: &fcx, parent_id: id }.visit_body(body);
1055
1056             fcx.check_expr_coercable_to_type(&body.value, revealed_ty, None);
1057
1058             fcx.write_ty(id, revealed_ty);
1059
1060             fcx
1061         };
1062
1063         // All type checking constraints were added, try to fallback unsolved variables.
1064         fcx.select_obligations_where_possible(false, |_| {});
1065         let mut fallback_has_occurred = false;
1066
1067         // We do fallback in two passes, to try to generate
1068         // better error messages.
1069         // The first time, we do *not* replace opaque types.
1070         for ty in &fcx.unsolved_variables() {
1071             fallback_has_occurred |= fcx.fallback_if_possible(ty, FallbackMode::NoOpaque);
1072         }
1073         // We now see if we can make progress. This might
1074         // cause us to unify inference variables for opaque types,
1075         // since we may have unified some other type variables
1076         // during the first phase of fallback.
1077         // This means that we only replace inference variables with their underlying
1078         // opaque types as a last resort.
1079         //
1080         // In code like this:
1081         //
1082         // ```rust
1083         // type MyType = impl Copy;
1084         // fn produce() -> MyType { true }
1085         // fn bad_produce() -> MyType { panic!() }
1086         // ```
1087         //
1088         // we want to unify the opaque inference variable in `bad_produce`
1089         // with the diverging fallback for `panic!` (e.g. `()` or `!`).
1090         // This will produce a nice error message about conflicting concrete
1091         // types for `MyType`.
1092         //
1093         // If we had tried to fallback the opaque inference variable to `MyType`,
1094         // we will generate a confusing type-check error that does not explicitly
1095         // refer to opaque types.
1096         fcx.select_obligations_where_possible(fallback_has_occurred, |_| {});
1097
1098         // We now run fallback again, but this time we allow it to replace
1099         // unconstrained opaque type variables, in addition to performing
1100         // other kinds of fallback.
1101         for ty in &fcx.unsolved_variables() {
1102             fallback_has_occurred |= fcx.fallback_if_possible(ty, FallbackMode::All);
1103         }
1104
1105         // See if we can make any more progress.
1106         fcx.select_obligations_where_possible(fallback_has_occurred, |_| {});
1107
1108         // Even though coercion casts provide type hints, we check casts after fallback for
1109         // backwards compatibility. This makes fallback a stronger type hint than a cast coercion.
1110         fcx.check_casts();
1111
1112         // Closure and generator analysis may run after fallback
1113         // because they don't constrain other type variables.
1114         fcx.closure_analyze(body);
1115         assert!(fcx.deferred_call_resolutions.borrow().is_empty());
1116         fcx.resolve_generator_interiors(def_id.to_def_id());
1117
1118         for (ty, span, code) in fcx.deferred_sized_obligations.borrow_mut().drain(..) {
1119             let ty = fcx.normalize_ty(span, ty);
1120             fcx.require_type_is_sized(ty, span, code);
1121         }
1122
1123         fcx.select_all_obligations_or_error();
1124
1125         if fn_decl.is_some() {
1126             fcx.regionck_fn(id, body);
1127         } else {
1128             fcx.regionck_expr(body);
1129         }
1130
1131         fcx.resolve_type_vars_in_body(body)
1132     });
1133
1134     // Consistency check our TypeckResults instance can hold all ItemLocalIds
1135     // it will need to hold.
1136     assert_eq!(typeck_results.hir_owner, id.owner);
1137
1138     typeck_results
1139 }
1140
1141 fn check_abi(tcx: TyCtxt<'_>, span: Span, abi: Abi) {
1142     if !tcx.sess.target.target.is_abi_supported(abi) {
1143         struct_span_err!(
1144             tcx.sess,
1145             span,
1146             E0570,
1147             "The ABI `{}` is not supported for the current target",
1148             abi
1149         )
1150         .emit()
1151     }
1152 }
1153
1154 struct GatherLocalsVisitor<'a, 'tcx> {
1155     fcx: &'a FnCtxt<'a, 'tcx>,
1156     parent_id: hir::HirId,
1157 }
1158
1159 impl<'a, 'tcx> GatherLocalsVisitor<'a, 'tcx> {
1160     fn assign(&mut self, span: Span, nid: hir::HirId, ty_opt: Option<LocalTy<'tcx>>) -> Ty<'tcx> {
1161         match ty_opt {
1162             None => {
1163                 // Infer the variable's type.
1164                 let var_ty = self.fcx.next_ty_var(TypeVariableOrigin {
1165                     kind: TypeVariableOriginKind::TypeInference,
1166                     span,
1167                 });
1168                 self.fcx
1169                     .locals
1170                     .borrow_mut()
1171                     .insert(nid, LocalTy { decl_ty: var_ty, revealed_ty: var_ty });
1172                 var_ty
1173             }
1174             Some(typ) => {
1175                 // Take type that the user specified.
1176                 self.fcx.locals.borrow_mut().insert(nid, typ);
1177                 typ.revealed_ty
1178             }
1179         }
1180     }
1181 }
1182
1183 impl<'a, 'tcx> Visitor<'tcx> for GatherLocalsVisitor<'a, 'tcx> {
1184     type Map = intravisit::ErasedMap<'tcx>;
1185
1186     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
1187         NestedVisitorMap::None
1188     }
1189
1190     // Add explicitly-declared locals.
1191     fn visit_local(&mut self, local: &'tcx hir::Local<'tcx>) {
1192         let local_ty = match local.ty {
1193             Some(ref ty) => {
1194                 let o_ty = self.fcx.to_ty(&ty);
1195
1196                 let revealed_ty = if self.fcx.tcx.features().impl_trait_in_bindings {
1197                     self.fcx.instantiate_opaque_types_from_value(self.parent_id, &o_ty, ty.span)
1198                 } else {
1199                     o_ty
1200                 };
1201
1202                 let c_ty = self
1203                     .fcx
1204                     .inh
1205                     .infcx
1206                     .canonicalize_user_type_annotation(&UserType::Ty(revealed_ty));
1207                 debug!(
1208                     "visit_local: ty.hir_id={:?} o_ty={:?} revealed_ty={:?} c_ty={:?}",
1209                     ty.hir_id, o_ty, revealed_ty, c_ty
1210                 );
1211                 self.fcx
1212                     .typeck_results
1213                     .borrow_mut()
1214                     .user_provided_types_mut()
1215                     .insert(ty.hir_id, c_ty);
1216
1217                 Some(LocalTy { decl_ty: o_ty, revealed_ty })
1218             }
1219             None => None,
1220         };
1221         self.assign(local.span, local.hir_id, local_ty);
1222
1223         debug!(
1224             "local variable {:?} is assigned type {}",
1225             local.pat,
1226             self.fcx.ty_to_string(&*self.fcx.locals.borrow().get(&local.hir_id).unwrap().decl_ty)
1227         );
1228         intravisit::walk_local(self, local);
1229     }
1230
1231     // Add pattern bindings.
1232     fn visit_pat(&mut self, p: &'tcx hir::Pat<'tcx>) {
1233         if let PatKind::Binding(_, _, ident, _) = p.kind {
1234             let var_ty = self.assign(p.span, p.hir_id, None);
1235
1236             if !self.fcx.tcx.features().unsized_locals {
1237                 self.fcx.require_type_is_sized(var_ty, p.span, traits::VariableType(p.hir_id));
1238             }
1239
1240             debug!(
1241                 "pattern binding {} is assigned to {} with type {:?}",
1242                 ident,
1243                 self.fcx.ty_to_string(&*self.fcx.locals.borrow().get(&p.hir_id).unwrap().decl_ty),
1244                 var_ty
1245             );
1246         }
1247         intravisit::walk_pat(self, p);
1248     }
1249
1250     // Don't descend into the bodies of nested closures.
1251     fn visit_fn(
1252         &mut self,
1253         _: intravisit::FnKind<'tcx>,
1254         _: &'tcx hir::FnDecl<'tcx>,
1255         _: hir::BodyId,
1256         _: Span,
1257         _: hir::HirId,
1258     ) {
1259     }
1260 }
1261
1262 /// When `check_fn` is invoked on a generator (i.e., a body that
1263 /// includes yield), it returns back some information about the yield
1264 /// points.
1265 struct GeneratorTypes<'tcx> {
1266     /// Type of generator argument / values returned by `yield`.
1267     resume_ty: Ty<'tcx>,
1268
1269     /// Type of value that is yielded.
1270     yield_ty: Ty<'tcx>,
1271
1272     /// Types that are captured (see `GeneratorInterior` for more).
1273     interior: Ty<'tcx>,
1274
1275     /// Indicates if the generator is movable or static (immovable).
1276     movability: hir::Movability,
1277 }
1278
1279 /// Helper used for fns and closures. Does the grungy work of checking a function
1280 /// body and returns the function context used for that purpose, since in the case of a fn item
1281 /// there is still a bit more to do.
1282 ///
1283 /// * ...
1284 /// * inherited: other fields inherited from the enclosing fn (if any)
1285 fn check_fn<'a, 'tcx>(
1286     inherited: &'a Inherited<'a, 'tcx>,
1287     param_env: ty::ParamEnv<'tcx>,
1288     fn_sig: ty::FnSig<'tcx>,
1289     decl: &'tcx hir::FnDecl<'tcx>,
1290     fn_id: hir::HirId,
1291     body: &'tcx hir::Body<'tcx>,
1292     can_be_generator: Option<hir::Movability>,
1293 ) -> (FnCtxt<'a, 'tcx>, Option<GeneratorTypes<'tcx>>) {
1294     let mut fn_sig = fn_sig;
1295
1296     debug!("check_fn(sig={:?}, fn_id={}, param_env={:?})", fn_sig, fn_id, param_env);
1297
1298     // Create the function context. This is either derived from scratch or,
1299     // in the case of closures, based on the outer context.
1300     let mut fcx = FnCtxt::new(inherited, param_env, body.value.hir_id);
1301     *fcx.ps.borrow_mut() = UnsafetyState::function(fn_sig.unsafety, fn_id);
1302
1303     let tcx = fcx.tcx;
1304     let sess = tcx.sess;
1305     let hir = tcx.hir();
1306
1307     let declared_ret_ty = fn_sig.output();
1308     let revealed_ret_ty =
1309         fcx.instantiate_opaque_types_from_value(fn_id, &declared_ret_ty, decl.output.span());
1310     debug!("check_fn: declared_ret_ty: {}, revealed_ret_ty: {}", declared_ret_ty, revealed_ret_ty);
1311     fcx.ret_coercion = Some(RefCell::new(CoerceMany::new(revealed_ret_ty)));
1312     fn_sig = tcx.mk_fn_sig(
1313         fn_sig.inputs().iter().cloned(),
1314         revealed_ret_ty,
1315         fn_sig.c_variadic,
1316         fn_sig.unsafety,
1317         fn_sig.abi,
1318     );
1319
1320     let span = body.value.span;
1321
1322     fn_maybe_err(tcx, span, fn_sig.abi);
1323
1324     if body.generator_kind.is_some() && can_be_generator.is_some() {
1325         let yield_ty = fcx
1326             .next_ty_var(TypeVariableOrigin { kind: TypeVariableOriginKind::TypeInference, span });
1327         fcx.require_type_is_sized(yield_ty, span, traits::SizedYieldType);
1328
1329         // Resume type defaults to `()` if the generator has no argument.
1330         let resume_ty = fn_sig.inputs().get(0).copied().unwrap_or_else(|| tcx.mk_unit());
1331
1332         fcx.resume_yield_tys = Some((resume_ty, yield_ty));
1333     }
1334
1335     let outer_def_id = tcx.closure_base_def_id(hir.local_def_id(fn_id).to_def_id()).expect_local();
1336     let outer_hir_id = hir.as_local_hir_id(outer_def_id);
1337     GatherLocalsVisitor { fcx: &fcx, parent_id: outer_hir_id }.visit_body(body);
1338
1339     // C-variadic fns also have a `VaList` input that's not listed in `fn_sig`
1340     // (as it's created inside the body itself, not passed in from outside).
1341     let maybe_va_list = if fn_sig.c_variadic {
1342         let span = body.params.last().unwrap().span;
1343         let va_list_did = tcx.require_lang_item(VaListTypeLangItem, Some(span));
1344         let region = fcx.next_region_var(RegionVariableOrigin::MiscVariable(span));
1345
1346         Some(tcx.type_of(va_list_did).subst(tcx, &[region.into()]))
1347     } else {
1348         None
1349     };
1350
1351     // Add formal parameters.
1352     let inputs_hir = hir.fn_decl_by_hir_id(fn_id).map(|decl| &decl.inputs);
1353     let inputs_fn = fn_sig.inputs().iter().copied();
1354     for (idx, (param_ty, param)) in inputs_fn.chain(maybe_va_list).zip(body.params).enumerate() {
1355         // Check the pattern.
1356         let ty_span = try { inputs_hir?.get(idx)?.span };
1357         fcx.check_pat_top(&param.pat, param_ty, ty_span, false);
1358
1359         // Check that argument is Sized.
1360         // The check for a non-trivial pattern is a hack to avoid duplicate warnings
1361         // for simple cases like `fn foo(x: Trait)`,
1362         // where we would error once on the parameter as a whole, and once on the binding `x`.
1363         if param.pat.simple_ident().is_none() && !tcx.features().unsized_locals {
1364             fcx.require_type_is_sized(param_ty, param.pat.span, traits::SizedArgumentType(ty_span));
1365         }
1366
1367         fcx.write_ty(param.hir_id, param_ty);
1368     }
1369
1370     inherited.typeck_results.borrow_mut().liberated_fn_sigs_mut().insert(fn_id, fn_sig);
1371
1372     if let ty::Dynamic(..) = declared_ret_ty.kind {
1373         // FIXME: We need to verify that the return type is `Sized` after the return expression has
1374         // been evaluated so that we have types available for all the nodes being returned, but that
1375         // requires the coerced evaluated type to be stored. Moving `check_return_expr` before this
1376         // causes unsized errors caused by the `declared_ret_ty` to point at the return expression,
1377         // while keeping the current ordering we will ignore the tail expression's type because we
1378         // don't know it yet. We can't do `check_expr_kind` while keeping `check_return_expr`
1379         // because we will trigger "unreachable expression" lints unconditionally.
1380         // Because of all of this, we perform a crude check to know whether the simplest `!Sized`
1381         // case that a newcomer might make, returning a bare trait, and in that case we populate
1382         // the tail expression's type so that the suggestion will be correct, but ignore all other
1383         // possible cases.
1384         fcx.check_expr(&body.value);
1385         fcx.require_type_is_sized(declared_ret_ty, decl.output.span(), traits::SizedReturnType);
1386         tcx.sess.delay_span_bug(decl.output.span(), "`!Sized` return type");
1387     } else {
1388         fcx.require_type_is_sized(declared_ret_ty, decl.output.span(), traits::SizedReturnType);
1389         fcx.check_return_expr(&body.value);
1390     }
1391
1392     // We insert the deferred_generator_interiors entry after visiting the body.
1393     // This ensures that all nested generators appear before the entry of this generator.
1394     // resolve_generator_interiors relies on this property.
1395     let gen_ty = if let (Some(_), Some(gen_kind)) = (can_be_generator, body.generator_kind) {
1396         let interior = fcx
1397             .next_ty_var(TypeVariableOrigin { kind: TypeVariableOriginKind::MiscVariable, span });
1398         fcx.deferred_generator_interiors.borrow_mut().push((body.id(), interior, gen_kind));
1399
1400         let (resume_ty, yield_ty) = fcx.resume_yield_tys.unwrap();
1401         Some(GeneratorTypes {
1402             resume_ty,
1403             yield_ty,
1404             interior,
1405             movability: can_be_generator.unwrap(),
1406         })
1407     } else {
1408         None
1409     };
1410
1411     // Finalize the return check by taking the LUB of the return types
1412     // we saw and assigning it to the expected return type. This isn't
1413     // really expected to fail, since the coercions would have failed
1414     // earlier when trying to find a LUB.
1415     //
1416     // However, the behavior around `!` is sort of complex. In the
1417     // event that the `actual_return_ty` comes back as `!`, that
1418     // indicates that the fn either does not return or "returns" only
1419     // values of type `!`. In this case, if there is an expected
1420     // return type that is *not* `!`, that should be ok. But if the
1421     // return type is being inferred, we want to "fallback" to `!`:
1422     //
1423     //     let x = move || panic!();
1424     //
1425     // To allow for that, I am creating a type variable with diverging
1426     // fallback. This was deemed ever so slightly better than unifying
1427     // the return value with `!` because it allows for the caller to
1428     // make more assumptions about the return type (e.g., they could do
1429     //
1430     //     let y: Option<u32> = Some(x());
1431     //
1432     // which would then cause this return type to become `u32`, not
1433     // `!`).
1434     let coercion = fcx.ret_coercion.take().unwrap().into_inner();
1435     let mut actual_return_ty = coercion.complete(&fcx);
1436     if actual_return_ty.is_never() {
1437         actual_return_ty = fcx.next_diverging_ty_var(TypeVariableOrigin {
1438             kind: TypeVariableOriginKind::DivergingFn,
1439             span,
1440         });
1441     }
1442     fcx.demand_suptype(span, revealed_ret_ty, actual_return_ty);
1443
1444     // Check that the main return type implements the termination trait.
1445     if let Some(term_id) = tcx.lang_items().termination() {
1446         if let Some((def_id, EntryFnType::Main)) = tcx.entry_fn(LOCAL_CRATE) {
1447             let main_id = hir.as_local_hir_id(def_id);
1448             if main_id == fn_id {
1449                 let substs = tcx.mk_substs_trait(declared_ret_ty, &[]);
1450                 let trait_ref = ty::TraitRef::new(term_id, substs);
1451                 let return_ty_span = decl.output.span();
1452                 let cause = traits::ObligationCause::new(
1453                     return_ty_span,
1454                     fn_id,
1455                     ObligationCauseCode::MainFunctionType,
1456                 );
1457
1458                 inherited.register_predicate(traits::Obligation::new(
1459                     cause,
1460                     param_env,
1461                     trait_ref.without_const().to_predicate(tcx),
1462                 ));
1463             }
1464         }
1465     }
1466
1467     // Check that a function marked as `#[panic_handler]` has signature `fn(&PanicInfo) -> !`
1468     if let Some(panic_impl_did) = tcx.lang_items().panic_impl() {
1469         if panic_impl_did == hir.local_def_id(fn_id).to_def_id() {
1470             if let Some(panic_info_did) = tcx.lang_items().panic_info() {
1471                 if declared_ret_ty.kind != ty::Never {
1472                     sess.span_err(decl.output.span(), "return type should be `!`");
1473                 }
1474
1475                 let inputs = fn_sig.inputs();
1476                 let span = hir.span(fn_id);
1477                 if inputs.len() == 1 {
1478                     let arg_is_panic_info = match inputs[0].kind {
1479                         ty::Ref(region, ty, mutbl) => match ty.kind {
1480                             ty::Adt(ref adt, _) => {
1481                                 adt.did == panic_info_did
1482                                     && mutbl == hir::Mutability::Not
1483                                     && *region != RegionKind::ReStatic
1484                             }
1485                             _ => false,
1486                         },
1487                         _ => false,
1488                     };
1489
1490                     if !arg_is_panic_info {
1491                         sess.span_err(decl.inputs[0].span, "argument should be `&PanicInfo`");
1492                     }
1493
1494                     if let Node::Item(item) = hir.get(fn_id) {
1495                         if let ItemKind::Fn(_, ref generics, _) = item.kind {
1496                             if !generics.params.is_empty() {
1497                                 sess.span_err(span, "should have no type parameters");
1498                             }
1499                         }
1500                     }
1501                 } else {
1502                     let span = sess.source_map().guess_head_span(span);
1503                     sess.span_err(span, "function should have one argument");
1504                 }
1505             } else {
1506                 sess.err("language item required, but not found: `panic_info`");
1507             }
1508         }
1509     }
1510
1511     // Check that a function marked as `#[alloc_error_handler]` has signature `fn(Layout) -> !`
1512     if let Some(alloc_error_handler_did) = tcx.lang_items().oom() {
1513         if alloc_error_handler_did == hir.local_def_id(fn_id).to_def_id() {
1514             if let Some(alloc_layout_did) = tcx.lang_items().alloc_layout() {
1515                 if declared_ret_ty.kind != ty::Never {
1516                     sess.span_err(decl.output.span(), "return type should be `!`");
1517                 }
1518
1519                 let inputs = fn_sig.inputs();
1520                 let span = hir.span(fn_id);
1521                 if inputs.len() == 1 {
1522                     let arg_is_alloc_layout = match inputs[0].kind {
1523                         ty::Adt(ref adt, _) => adt.did == alloc_layout_did,
1524                         _ => false,
1525                     };
1526
1527                     if !arg_is_alloc_layout {
1528                         sess.span_err(decl.inputs[0].span, "argument should be `Layout`");
1529                     }
1530
1531                     if let Node::Item(item) = hir.get(fn_id) {
1532                         if let ItemKind::Fn(_, ref generics, _) = item.kind {
1533                             if !generics.params.is_empty() {
1534                                 sess.span_err(
1535                                     span,
1536                                     "`#[alloc_error_handler]` function should have no type \
1537                                      parameters",
1538                                 );
1539                             }
1540                         }
1541                     }
1542                 } else {
1543                     let span = sess.source_map().guess_head_span(span);
1544                     sess.span_err(span, "function should have one argument");
1545                 }
1546             } else {
1547                 sess.err("language item required, but not found: `alloc_layout`");
1548             }
1549         }
1550     }
1551
1552     (fcx, gen_ty)
1553 }
1554
1555 fn check_struct(tcx: TyCtxt<'_>, id: hir::HirId, span: Span) {
1556     let def_id = tcx.hir().local_def_id(id);
1557     let def = tcx.adt_def(def_id);
1558     def.destructor(tcx); // force the destructor to be evaluated
1559     check_representable(tcx, span, def_id);
1560
1561     if def.repr.simd() {
1562         check_simd(tcx, span, def_id);
1563     }
1564
1565     check_transparent(tcx, span, def);
1566     check_packed(tcx, span, def);
1567 }
1568
1569 fn check_union(tcx: TyCtxt<'_>, id: hir::HirId, span: Span) {
1570     let def_id = tcx.hir().local_def_id(id);
1571     let def = tcx.adt_def(def_id);
1572     def.destructor(tcx); // force the destructor to be evaluated
1573     check_representable(tcx, span, def_id);
1574     check_transparent(tcx, span, def);
1575     check_union_fields(tcx, span, def_id);
1576     check_packed(tcx, span, def);
1577 }
1578
1579 /// When the `#![feature(untagged_unions)]` gate is active,
1580 /// check that the fields of the `union` does not contain fields that need dropping.
1581 fn check_union_fields(tcx: TyCtxt<'_>, span: Span, item_def_id: LocalDefId) -> bool {
1582     let item_type = tcx.type_of(item_def_id);
1583     if let ty::Adt(def, substs) = item_type.kind {
1584         assert!(def.is_union());
1585         let fields = &def.non_enum_variant().fields;
1586         let param_env = tcx.param_env(item_def_id);
1587         for field in fields {
1588             let field_ty = field.ty(tcx, substs);
1589             // We are currently checking the type this field came from, so it must be local.
1590             let field_span = tcx.hir().span_if_local(field.did).unwrap();
1591             if field_ty.needs_drop(tcx, param_env) {
1592                 struct_span_err!(
1593                     tcx.sess,
1594                     field_span,
1595                     E0740,
1596                     "unions may not contain fields that need dropping"
1597                 )
1598                 .span_note(field_span, "`std::mem::ManuallyDrop` can be used to wrap the type")
1599                 .emit();
1600                 return false;
1601             }
1602         }
1603     } else {
1604         span_bug!(span, "unions must be ty::Adt, but got {:?}", item_type.kind);
1605     }
1606     true
1607 }
1608
1609 /// Checks that an opaque type does not contain cycles and does not use `Self` or `T::Foo`
1610 /// projections that would result in "inheriting lifetimes".
1611 fn check_opaque<'tcx>(
1612     tcx: TyCtxt<'tcx>,
1613     def_id: LocalDefId,
1614     substs: SubstsRef<'tcx>,
1615     span: Span,
1616     origin: &hir::OpaqueTyOrigin,
1617 ) {
1618     check_opaque_for_inheriting_lifetimes(tcx, def_id, span);
1619     check_opaque_for_cycles(tcx, def_id, substs, span, origin);
1620 }
1621
1622 /// Checks that an opaque type does not use `Self` or `T::Foo` projections that would result
1623 /// in "inheriting lifetimes".
1624 fn check_opaque_for_inheriting_lifetimes(tcx: TyCtxt<'tcx>, def_id: LocalDefId, span: Span) {
1625     let item = tcx.hir().expect_item(tcx.hir().as_local_hir_id(def_id));
1626     debug!(
1627         "check_opaque_for_inheriting_lifetimes: def_id={:?} span={:?} item={:?}",
1628         def_id, span, item
1629     );
1630
1631     #[derive(Debug)]
1632     struct ProhibitOpaqueVisitor<'tcx> {
1633         opaque_identity_ty: Ty<'tcx>,
1634         generics: &'tcx ty::Generics,
1635         ty: Option<Ty<'tcx>>,
1636     };
1637
1638     impl<'tcx> ty::fold::TypeVisitor<'tcx> for ProhibitOpaqueVisitor<'tcx> {
1639         fn visit_ty(&mut self, t: Ty<'tcx>) -> bool {
1640             debug!("check_opaque_for_inheriting_lifetimes: (visit_ty) t={:?}", t);
1641             if t != self.opaque_identity_ty && t.super_visit_with(self) {
1642                 self.ty = Some(t);
1643                 return true;
1644             }
1645             false
1646         }
1647
1648         fn visit_region(&mut self, r: ty::Region<'tcx>) -> bool {
1649             debug!("check_opaque_for_inheriting_lifetimes: (visit_region) r={:?}", r);
1650             if let RegionKind::ReEarlyBound(ty::EarlyBoundRegion { index, .. }) = r {
1651                 return *index < self.generics.parent_count as u32;
1652             }
1653
1654             r.super_visit_with(self)
1655         }
1656
1657         fn visit_const(&mut self, c: &'tcx ty::Const<'tcx>) -> bool {
1658             if let ty::ConstKind::Unevaluated(..) = c.val {
1659                 // FIXME(#72219) We currenctly don't detect lifetimes within substs
1660                 // which would violate this check. Even though the particular substitution is not used
1661                 // within the const, this should still be fixed.
1662                 return false;
1663             }
1664             c.super_visit_with(self)
1665         }
1666     }
1667
1668     if let ItemKind::OpaqueTy(hir::OpaqueTy {
1669         origin: hir::OpaqueTyOrigin::AsyncFn | hir::OpaqueTyOrigin::FnReturn,
1670         ..
1671     }) = item.kind
1672     {
1673         let mut visitor = ProhibitOpaqueVisitor {
1674             opaque_identity_ty: tcx.mk_opaque(
1675                 def_id.to_def_id(),
1676                 InternalSubsts::identity_for_item(tcx, def_id.to_def_id()),
1677             ),
1678             generics: tcx.generics_of(def_id),
1679             ty: None,
1680         };
1681         let prohibit_opaque = tcx
1682             .predicates_of(def_id)
1683             .predicates
1684             .iter()
1685             .any(|(predicate, _)| predicate.visit_with(&mut visitor));
1686         debug!(
1687             "check_opaque_for_inheriting_lifetimes: prohibit_opaque={:?}, visitor={:?}",
1688             prohibit_opaque, visitor
1689         );
1690
1691         if prohibit_opaque {
1692             let is_async = match item.kind {
1693                 ItemKind::OpaqueTy(hir::OpaqueTy { origin, .. }) => match origin {
1694                     hir::OpaqueTyOrigin::AsyncFn => true,
1695                     _ => false,
1696                 },
1697                 _ => unreachable!(),
1698             };
1699
1700             let mut err = struct_span_err!(
1701                 tcx.sess,
1702                 span,
1703                 E0760,
1704                 "`{}` return type cannot contain a projection or `Self` that references lifetimes from \
1705              a parent scope",
1706                 if is_async { "async fn" } else { "impl Trait" },
1707             );
1708
1709             if let Ok(snippet) = tcx.sess.source_map().span_to_snippet(span) {
1710                 if snippet == "Self" {
1711                     if let Some(ty) = visitor.ty {
1712                         err.span_suggestion(
1713                             span,
1714                             "consider spelling out the type instead",
1715                             format!("{:?}", ty),
1716                             Applicability::MaybeIncorrect,
1717                         );
1718                     }
1719                 }
1720             }
1721             err.emit();
1722         }
1723     }
1724 }
1725
1726 /// Given a `DefId` for an opaque type in return position, find its parent item's return
1727 /// expressions.
1728 fn get_owner_return_paths(
1729     tcx: TyCtxt<'tcx>,
1730     def_id: LocalDefId,
1731 ) -> Option<(hir::HirId, ReturnsVisitor<'tcx>)> {
1732     let hir_id = tcx.hir().as_local_hir_id(def_id);
1733     let id = tcx.hir().get_parent_item(hir_id);
1734     tcx.hir()
1735         .find(id)
1736         .map(|n| (id, n))
1737         .and_then(|(hir_id, node)| node.body_id().map(|b| (hir_id, b)))
1738         .map(|(hir_id, body_id)| {
1739             let body = tcx.hir().body(body_id);
1740             let mut visitor = ReturnsVisitor::default();
1741             visitor.visit_body(body);
1742             (hir_id, visitor)
1743         })
1744 }
1745
1746 /// Emit an error for recursive opaque types.
1747 ///
1748 /// If this is a return `impl Trait`, find the item's return expressions and point at them. For
1749 /// direct recursion this is enough, but for indirect recursion also point at the last intermediary
1750 /// `impl Trait`.
1751 ///
1752 /// If all the return expressions evaluate to `!`, then we explain that the error will go away
1753 /// after changing it. This can happen when a user uses `panic!()` or similar as a placeholder.
1754 fn opaque_type_cycle_error(tcx: TyCtxt<'tcx>, def_id: LocalDefId, span: Span) {
1755     let mut err = struct_span_err!(tcx.sess, span, E0720, "cannot resolve opaque type");
1756
1757     let mut label = false;
1758     if let Some((hir_id, visitor)) = get_owner_return_paths(tcx, def_id) {
1759         let typeck_results = tcx.typeck(tcx.hir().local_def_id(hir_id));
1760         if visitor
1761             .returns
1762             .iter()
1763             .filter_map(|expr| typeck_results.node_type_opt(expr.hir_id))
1764             .all(|ty| matches!(ty.kind, ty::Never))
1765         {
1766             let spans = visitor
1767                 .returns
1768                 .iter()
1769                 .filter(|expr| typeck_results.node_type_opt(expr.hir_id).is_some())
1770                 .map(|expr| expr.span)
1771                 .collect::<Vec<Span>>();
1772             let span_len = spans.len();
1773             if span_len == 1 {
1774                 err.span_label(spans[0], "this returned value is of `!` type");
1775             } else {
1776                 let mut multispan: MultiSpan = spans.clone().into();
1777                 for span in spans {
1778                     multispan
1779                         .push_span_label(span, "this returned value is of `!` type".to_string());
1780                 }
1781                 err.span_note(multispan, "these returned values have a concrete \"never\" type");
1782             }
1783             err.help("this error will resolve once the item's body returns a concrete type");
1784         } else {
1785             let mut seen = FxHashSet::default();
1786             seen.insert(span);
1787             err.span_label(span, "recursive opaque type");
1788             label = true;
1789             for (sp, ty) in visitor
1790                 .returns
1791                 .iter()
1792                 .filter_map(|e| typeck_results.node_type_opt(e.hir_id).map(|t| (e.span, t)))
1793                 .filter(|(_, ty)| !matches!(ty.kind, ty::Never))
1794             {
1795                 struct VisitTypes(Vec<DefId>);
1796                 impl<'tcx> ty::fold::TypeVisitor<'tcx> for VisitTypes {
1797                     fn visit_ty(&mut self, t: Ty<'tcx>) -> bool {
1798                         match t.kind {
1799                             ty::Opaque(def, _) => {
1800                                 self.0.push(def);
1801                                 false
1802                             }
1803                             _ => t.super_visit_with(self),
1804                         }
1805                     }
1806                 }
1807                 let mut visitor = VisitTypes(vec![]);
1808                 ty.visit_with(&mut visitor);
1809                 for def_id in visitor.0 {
1810                     let ty_span = tcx.def_span(def_id);
1811                     if !seen.contains(&ty_span) {
1812                         err.span_label(ty_span, &format!("returning this opaque type `{}`", ty));
1813                         seen.insert(ty_span);
1814                     }
1815                     err.span_label(sp, &format!("returning here with type `{}`", ty));
1816                 }
1817             }
1818         }
1819     }
1820     if !label {
1821         err.span_label(span, "cannot resolve opaque type");
1822     }
1823     err.emit();
1824 }
1825
1826 /// Emit an error for recursive opaque types in a `let` binding.
1827 fn binding_opaque_type_cycle_error(
1828     tcx: TyCtxt<'tcx>,
1829     def_id: LocalDefId,
1830     span: Span,
1831     partially_expanded_type: Ty<'tcx>,
1832 ) {
1833     let mut err = struct_span_err!(tcx.sess, span, E0720, "cannot resolve opaque type");
1834     err.span_label(span, "cannot resolve opaque type");
1835     // Find the the owner that declared this `impl Trait` type.
1836     let hir_id = tcx.hir().as_local_hir_id(def_id);
1837     let mut prev_hir_id = hir_id;
1838     let mut hir_id = tcx.hir().get_parent_node(hir_id);
1839     while let Some(node) = tcx.hir().find(hir_id) {
1840         match node {
1841             hir::Node::Local(hir::Local {
1842                 pat,
1843                 init: None,
1844                 ty: Some(ty),
1845                 source: hir::LocalSource::Normal,
1846                 ..
1847             }) => {
1848                 err.span_label(pat.span, "this binding might not have a concrete type");
1849                 err.span_suggestion_verbose(
1850                     ty.span.shrink_to_hi(),
1851                     "set the binding to a value for a concrete type to be resolved",
1852                     " = /* value */".to_string(),
1853                     Applicability::HasPlaceholders,
1854                 );
1855             }
1856             hir::Node::Local(hir::Local {
1857                 init: Some(expr),
1858                 source: hir::LocalSource::Normal,
1859                 ..
1860             }) => {
1861                 let hir_id = tcx.hir().as_local_hir_id(def_id);
1862                 let typeck_results =
1863                     tcx.typeck(tcx.hir().local_def_id(tcx.hir().get_parent_item(hir_id)));
1864                 if let Some(ty) = typeck_results.node_type_opt(expr.hir_id) {
1865                     err.span_label(
1866                         expr.span,
1867                         &format!(
1868                             "this is of type `{}`, which doesn't constrain \
1869                              `{}` enough to arrive to a concrete type",
1870                             ty, partially_expanded_type
1871                         ),
1872                     );
1873                 }
1874             }
1875             _ => {}
1876         }
1877         if prev_hir_id == hir_id {
1878             break;
1879         }
1880         prev_hir_id = hir_id;
1881         hir_id = tcx.hir().get_parent_node(hir_id);
1882     }
1883     err.emit();
1884 }
1885
1886 fn async_opaque_type_cycle_error(tcx: TyCtxt<'tcx>, span: Span) {
1887     struct_span_err!(tcx.sess, span, E0733, "recursion in an `async fn` requires boxing")
1888         .span_label(span, "recursive `async fn`")
1889         .note("a recursive `async fn` must be rewritten to return a boxed `dyn Future`")
1890         .emit();
1891 }
1892
1893 /// Checks that an opaque type does not contain cycles.
1894 fn check_opaque_for_cycles<'tcx>(
1895     tcx: TyCtxt<'tcx>,
1896     def_id: LocalDefId,
1897     substs: SubstsRef<'tcx>,
1898     span: Span,
1899     origin: &hir::OpaqueTyOrigin,
1900 ) {
1901     if let Err(partially_expanded_type) = tcx.try_expand_impl_trait_type(def_id.to_def_id(), substs)
1902     {
1903         match origin {
1904             hir::OpaqueTyOrigin::AsyncFn => async_opaque_type_cycle_error(tcx, span),
1905             hir::OpaqueTyOrigin::Binding => {
1906                 binding_opaque_type_cycle_error(tcx, def_id, span, partially_expanded_type)
1907             }
1908             _ => opaque_type_cycle_error(tcx, def_id, span),
1909         }
1910     }
1911 }
1912
1913 // Forbid defining intrinsics in Rust code,
1914 // as they must always be defined by the compiler.
1915 fn fn_maybe_err(tcx: TyCtxt<'_>, sp: Span, abi: Abi) {
1916     if let Abi::RustIntrinsic | Abi::PlatformIntrinsic = abi {
1917         tcx.sess.span_err(sp, "intrinsic must be in `extern \"rust-intrinsic\" { ... }` block");
1918     }
1919 }
1920
1921 pub fn check_item_type<'tcx>(tcx: TyCtxt<'tcx>, it: &'tcx hir::Item<'tcx>) {
1922     debug!(
1923         "check_item_type(it.hir_id={}, it.name={})",
1924         it.hir_id,
1925         tcx.def_path_str(tcx.hir().local_def_id(it.hir_id).to_def_id())
1926     );
1927     let _indenter = indenter();
1928     match it.kind {
1929         // Consts can play a role in type-checking, so they are included here.
1930         hir::ItemKind::Static(..) => {
1931             let def_id = tcx.hir().local_def_id(it.hir_id);
1932             tcx.ensure().typeck(def_id);
1933             maybe_check_static_with_link_section(tcx, def_id, it.span);
1934         }
1935         hir::ItemKind::Const(..) => {
1936             tcx.ensure().typeck(tcx.hir().local_def_id(it.hir_id));
1937         }
1938         hir::ItemKind::Enum(ref enum_definition, _) => {
1939             check_enum(tcx, it.span, &enum_definition.variants, it.hir_id);
1940         }
1941         hir::ItemKind::Fn(..) => {} // entirely within check_item_body
1942         hir::ItemKind::Impl { ref items, .. } => {
1943             debug!("ItemKind::Impl {} with id {}", it.ident, it.hir_id);
1944             let impl_def_id = tcx.hir().local_def_id(it.hir_id);
1945             if let Some(impl_trait_ref) = tcx.impl_trait_ref(impl_def_id) {
1946                 check_impl_items_against_trait(tcx, it.span, impl_def_id, impl_trait_ref, items);
1947                 let trait_def_id = impl_trait_ref.def_id;
1948                 check_on_unimplemented(tcx, trait_def_id, it);
1949             }
1950         }
1951         hir::ItemKind::Trait(_, _, _, _, ref items) => {
1952             let def_id = tcx.hir().local_def_id(it.hir_id);
1953             check_on_unimplemented(tcx, def_id.to_def_id(), it);
1954
1955             for item in items.iter() {
1956                 let item = tcx.hir().trait_item(item.id);
1957                 if let hir::TraitItemKind::Fn(sig, _) = &item.kind {
1958                     let abi = sig.header.abi;
1959                     fn_maybe_err(tcx, item.ident.span, abi);
1960                 }
1961             }
1962         }
1963         hir::ItemKind::Struct(..) => {
1964             check_struct(tcx, it.hir_id, it.span);
1965         }
1966         hir::ItemKind::Union(..) => {
1967             check_union(tcx, it.hir_id, it.span);
1968         }
1969         hir::ItemKind::OpaqueTy(hir::OpaqueTy { origin, .. }) => {
1970             let def_id = tcx.hir().local_def_id(it.hir_id);
1971
1972             let substs = InternalSubsts::identity_for_item(tcx, def_id.to_def_id());
1973             check_opaque(tcx, def_id, substs, it.span, &origin);
1974         }
1975         hir::ItemKind::TyAlias(..) => {
1976             let def_id = tcx.hir().local_def_id(it.hir_id);
1977             let pty_ty = tcx.type_of(def_id);
1978             let generics = tcx.generics_of(def_id);
1979             check_type_params_are_used(tcx, &generics, pty_ty);
1980         }
1981         hir::ItemKind::ForeignMod(ref m) => {
1982             check_abi(tcx, it.span, m.abi);
1983
1984             if m.abi == Abi::RustIntrinsic {
1985                 for item in m.items {
1986                     intrinsic::check_intrinsic_type(tcx, item);
1987                 }
1988             } else if m.abi == Abi::PlatformIntrinsic {
1989                 for item in m.items {
1990                     intrinsic::check_platform_intrinsic_type(tcx, item);
1991                 }
1992             } else {
1993                 for item in m.items {
1994                     let generics = tcx.generics_of(tcx.hir().local_def_id(item.hir_id));
1995                     let own_counts = generics.own_counts();
1996                     if generics.params.len() - own_counts.lifetimes != 0 {
1997                         let (kinds, kinds_pl, egs) = match (own_counts.types, own_counts.consts) {
1998                             (_, 0) => ("type", "types", Some("u32")),
1999                             // We don't specify an example value, because we can't generate
2000                             // a valid value for any type.
2001                             (0, _) => ("const", "consts", None),
2002                             _ => ("type or const", "types or consts", None),
2003                         };
2004                         struct_span_err!(
2005                             tcx.sess,
2006                             item.span,
2007                             E0044,
2008                             "foreign items may not have {} parameters",
2009                             kinds,
2010                         )
2011                         .span_label(item.span, &format!("can't have {} parameters", kinds))
2012                         .help(
2013                             // FIXME: once we start storing spans for type arguments, turn this
2014                             // into a suggestion.
2015                             &format!(
2016                                 "replace the {} parameters with concrete {}{}",
2017                                 kinds,
2018                                 kinds_pl,
2019                                 egs.map(|egs| format!(" like `{}`", egs)).unwrap_or_default(),
2020                             ),
2021                         )
2022                         .emit();
2023                     }
2024
2025                     if let hir::ForeignItemKind::Fn(ref fn_decl, _, _) = item.kind {
2026                         require_c_abi_if_c_variadic(tcx, fn_decl, m.abi, item.span);
2027                     }
2028                 }
2029             }
2030         }
2031         _ => { /* nothing to do */ }
2032     }
2033 }
2034
2035 fn maybe_check_static_with_link_section(tcx: TyCtxt<'_>, id: LocalDefId, span: Span) {
2036     // Only restricted on wasm32 target for now
2037     if !tcx.sess.opts.target_triple.triple().starts_with("wasm32") {
2038         return;
2039     }
2040
2041     // If `#[link_section]` is missing, then nothing to verify
2042     let attrs = tcx.codegen_fn_attrs(id);
2043     if attrs.link_section.is_none() {
2044         return;
2045     }
2046
2047     // For the wasm32 target statics with `#[link_section]` are placed into custom
2048     // sections of the final output file, but this isn't link custom sections of
2049     // other executable formats. Namely we can only embed a list of bytes,
2050     // nothing with pointers to anything else or relocations. If any relocation
2051     // show up, reject them here.
2052     // `#[link_section]` may contain arbitrary, or even undefined bytes, but it is
2053     // the consumer's responsibility to ensure all bytes that have been read
2054     // have defined values.
2055     match tcx.const_eval_poly(id.to_def_id()) {
2056         Ok(ConstValue::ByRef { alloc, .. }) => {
2057             if alloc.relocations().len() != 0 {
2058                 let msg = "statics with a custom `#[link_section]` must be a \
2059                            simple list of bytes on the wasm target with no \
2060                            extra levels of indirection such as references";
2061                 tcx.sess.span_err(span, msg);
2062             }
2063         }
2064         Ok(_) => bug!("Matching on non-ByRef static"),
2065         Err(_) => {}
2066     }
2067 }
2068
2069 fn check_on_unimplemented(tcx: TyCtxt<'_>, trait_def_id: DefId, item: &hir::Item<'_>) {
2070     let item_def_id = tcx.hir().local_def_id(item.hir_id);
2071     // an error would be reported if this fails.
2072     let _ = traits::OnUnimplementedDirective::of_item(tcx, trait_def_id, item_def_id.to_def_id());
2073 }
2074
2075 fn report_forbidden_specialization(
2076     tcx: TyCtxt<'_>,
2077     impl_item: &hir::ImplItem<'_>,
2078     parent_impl: DefId,
2079 ) {
2080     let mut err = struct_span_err!(
2081         tcx.sess,
2082         impl_item.span,
2083         E0520,
2084         "`{}` specializes an item from a parent `impl`, but \
2085          that item is not marked `default`",
2086         impl_item.ident
2087     );
2088     err.span_label(impl_item.span, format!("cannot specialize default item `{}`", impl_item.ident));
2089
2090     match tcx.span_of_impl(parent_impl) {
2091         Ok(span) => {
2092             err.span_label(span, "parent `impl` is here");
2093             err.note(&format!(
2094                 "to specialize, `{}` in the parent `impl` must be marked `default`",
2095                 impl_item.ident
2096             ));
2097         }
2098         Err(cname) => {
2099             err.note(&format!("parent implementation is in crate `{}`", cname));
2100         }
2101     }
2102
2103     err.emit();
2104 }
2105
2106 fn check_specialization_validity<'tcx>(
2107     tcx: TyCtxt<'tcx>,
2108     trait_def: &ty::TraitDef,
2109     trait_item: &ty::AssocItem,
2110     impl_id: DefId,
2111     impl_item: &hir::ImplItem<'_>,
2112 ) {
2113     let kind = match impl_item.kind {
2114         hir::ImplItemKind::Const(..) => ty::AssocKind::Const,
2115         hir::ImplItemKind::Fn(..) => ty::AssocKind::Fn,
2116         hir::ImplItemKind::TyAlias(_) => ty::AssocKind::Type,
2117     };
2118
2119     let ancestors = match trait_def.ancestors(tcx, impl_id) {
2120         Ok(ancestors) => ancestors,
2121         Err(_) => return,
2122     };
2123     let mut ancestor_impls = ancestors
2124         .skip(1)
2125         .filter_map(|parent| {
2126             if parent.is_from_trait() {
2127                 None
2128             } else {
2129                 Some((parent, parent.item(tcx, trait_item.ident, kind, trait_def.def_id)))
2130             }
2131         })
2132         .peekable();
2133
2134     if ancestor_impls.peek().is_none() {
2135         // No parent, nothing to specialize.
2136         return;
2137     }
2138
2139     let opt_result = ancestor_impls.find_map(|(parent_impl, parent_item)| {
2140         match parent_item {
2141             // Parent impl exists, and contains the parent item we're trying to specialize, but
2142             // doesn't mark it `default`.
2143             Some(parent_item) if traits::impl_item_is_final(tcx, &parent_item) => {
2144                 Some(Err(parent_impl.def_id()))
2145             }
2146
2147             // Parent impl contains item and makes it specializable.
2148             Some(_) => Some(Ok(())),
2149
2150             // Parent impl doesn't mention the item. This means it's inherited from the
2151             // grandparent. In that case, if parent is a `default impl`, inherited items use the
2152             // "defaultness" from the grandparent, else they are final.
2153             None => {
2154                 if tcx.impl_defaultness(parent_impl.def_id()).is_default() {
2155                     None
2156                 } else {
2157                     Some(Err(parent_impl.def_id()))
2158                 }
2159             }
2160         }
2161     });
2162
2163     // If `opt_result` is `None`, we have only encountered `default impl`s that don't contain the
2164     // item. This is allowed, the item isn't actually getting specialized here.
2165     let result = opt_result.unwrap_or(Ok(()));
2166
2167     if let Err(parent_impl) = result {
2168         report_forbidden_specialization(tcx, impl_item, parent_impl);
2169     }
2170 }
2171
2172 fn check_impl_items_against_trait<'tcx>(
2173     tcx: TyCtxt<'tcx>,
2174     full_impl_span: Span,
2175     impl_id: LocalDefId,
2176     impl_trait_ref: ty::TraitRef<'tcx>,
2177     impl_item_refs: &[hir::ImplItemRef<'_>],
2178 ) {
2179     let impl_span = tcx.sess.source_map().guess_head_span(full_impl_span);
2180
2181     // If the trait reference itself is erroneous (so the compilation is going
2182     // to fail), skip checking the items here -- the `impl_item` table in `tcx`
2183     // isn't populated for such impls.
2184     if impl_trait_ref.references_error() {
2185         return;
2186     }
2187
2188     // Negative impls are not expected to have any items
2189     match tcx.impl_polarity(impl_id) {
2190         ty::ImplPolarity::Reservation | ty::ImplPolarity::Positive => {}
2191         ty::ImplPolarity::Negative => {
2192             if let [first_item_ref, ..] = impl_item_refs {
2193                 let first_item_span = tcx.hir().impl_item(first_item_ref.id).span;
2194                 struct_span_err!(
2195                     tcx.sess,
2196                     first_item_span,
2197                     E0749,
2198                     "negative impls cannot have any items"
2199                 )
2200                 .emit();
2201             }
2202             return;
2203         }
2204     }
2205
2206     // Locate trait definition and items
2207     let trait_def = tcx.trait_def(impl_trait_ref.def_id);
2208
2209     let impl_items = || impl_item_refs.iter().map(|iiref| tcx.hir().impl_item(iiref.id));
2210
2211     // Check existing impl methods to see if they are both present in trait
2212     // and compatible with trait signature
2213     for impl_item in impl_items() {
2214         let namespace = impl_item.kind.namespace();
2215         let ty_impl_item = tcx.associated_item(tcx.hir().local_def_id(impl_item.hir_id));
2216         let ty_trait_item = tcx
2217             .associated_items(impl_trait_ref.def_id)
2218             .find_by_name_and_namespace(tcx, ty_impl_item.ident, namespace, impl_trait_ref.def_id)
2219             .or_else(|| {
2220                 // Not compatible, but needed for the error message
2221                 tcx.associated_items(impl_trait_ref.def_id)
2222                     .filter_by_name(tcx, ty_impl_item.ident, impl_trait_ref.def_id)
2223                     .next()
2224             });
2225
2226         // Check that impl definition matches trait definition
2227         if let Some(ty_trait_item) = ty_trait_item {
2228             match impl_item.kind {
2229                 hir::ImplItemKind::Const(..) => {
2230                     // Find associated const definition.
2231                     if ty_trait_item.kind == ty::AssocKind::Const {
2232                         compare_const_impl(
2233                             tcx,
2234                             &ty_impl_item,
2235                             impl_item.span,
2236                             &ty_trait_item,
2237                             impl_trait_ref,
2238                         );
2239                     } else {
2240                         let mut err = struct_span_err!(
2241                             tcx.sess,
2242                             impl_item.span,
2243                             E0323,
2244                             "item `{}` is an associated const, \
2245                              which doesn't match its trait `{}`",
2246                             ty_impl_item.ident,
2247                             impl_trait_ref.print_only_trait_path()
2248                         );
2249                         err.span_label(impl_item.span, "does not match trait");
2250                         // We can only get the spans from local trait definition
2251                         // Same for E0324 and E0325
2252                         if let Some(trait_span) = tcx.hir().span_if_local(ty_trait_item.def_id) {
2253                             err.span_label(trait_span, "item in trait");
2254                         }
2255                         err.emit()
2256                     }
2257                 }
2258                 hir::ImplItemKind::Fn(..) => {
2259                     let opt_trait_span = tcx.hir().span_if_local(ty_trait_item.def_id);
2260                     if ty_trait_item.kind == ty::AssocKind::Fn {
2261                         compare_impl_method(
2262                             tcx,
2263                             &ty_impl_item,
2264                             impl_item.span,
2265                             &ty_trait_item,
2266                             impl_trait_ref,
2267                             opt_trait_span,
2268                         );
2269                     } else {
2270                         let mut err = struct_span_err!(
2271                             tcx.sess,
2272                             impl_item.span,
2273                             E0324,
2274                             "item `{}` is an associated method, \
2275                              which doesn't match its trait `{}`",
2276                             ty_impl_item.ident,
2277                             impl_trait_ref.print_only_trait_path()
2278                         );
2279                         err.span_label(impl_item.span, "does not match trait");
2280                         if let Some(trait_span) = opt_trait_span {
2281                             err.span_label(trait_span, "item in trait");
2282                         }
2283                         err.emit()
2284                     }
2285                 }
2286                 hir::ImplItemKind::TyAlias(_) => {
2287                     let opt_trait_span = tcx.hir().span_if_local(ty_trait_item.def_id);
2288                     if ty_trait_item.kind == ty::AssocKind::Type {
2289                         compare_ty_impl(
2290                             tcx,
2291                             &ty_impl_item,
2292                             impl_item.span,
2293                             &ty_trait_item,
2294                             impl_trait_ref,
2295                             opt_trait_span,
2296                         );
2297                     } else {
2298                         let mut err = struct_span_err!(
2299                             tcx.sess,
2300                             impl_item.span,
2301                             E0325,
2302                             "item `{}` is an associated type, \
2303                              which doesn't match its trait `{}`",
2304                             ty_impl_item.ident,
2305                             impl_trait_ref.print_only_trait_path()
2306                         );
2307                         err.span_label(impl_item.span, "does not match trait");
2308                         if let Some(trait_span) = opt_trait_span {
2309                             err.span_label(trait_span, "item in trait");
2310                         }
2311                         err.emit()
2312                     }
2313                 }
2314             }
2315
2316             check_specialization_validity(
2317                 tcx,
2318                 trait_def,
2319                 &ty_trait_item,
2320                 impl_id.to_def_id(),
2321                 impl_item,
2322             );
2323         }
2324     }
2325
2326     // Check for missing items from trait
2327     let mut missing_items = Vec::new();
2328     if let Ok(ancestors) = trait_def.ancestors(tcx, impl_id.to_def_id()) {
2329         for trait_item in tcx.associated_items(impl_trait_ref.def_id).in_definition_order() {
2330             let is_implemented = ancestors
2331                 .leaf_def(tcx, trait_item.ident, trait_item.kind)
2332                 .map(|node_item| !node_item.defining_node.is_from_trait())
2333                 .unwrap_or(false);
2334
2335             if !is_implemented && tcx.impl_defaultness(impl_id).is_final() {
2336                 if !trait_item.defaultness.has_value() {
2337                     missing_items.push(*trait_item);
2338                 }
2339             }
2340         }
2341     }
2342
2343     if !missing_items.is_empty() {
2344         missing_items_err(tcx, impl_span, &missing_items, full_impl_span);
2345     }
2346 }
2347
2348 fn missing_items_err(
2349     tcx: TyCtxt<'_>,
2350     impl_span: Span,
2351     missing_items: &[ty::AssocItem],
2352     full_impl_span: Span,
2353 ) {
2354     let missing_items_msg = missing_items
2355         .iter()
2356         .map(|trait_item| trait_item.ident.to_string())
2357         .collect::<Vec<_>>()
2358         .join("`, `");
2359
2360     let mut err = struct_span_err!(
2361         tcx.sess,
2362         impl_span,
2363         E0046,
2364         "not all trait items implemented, missing: `{}`",
2365         missing_items_msg
2366     );
2367     err.span_label(impl_span, format!("missing `{}` in implementation", missing_items_msg));
2368
2369     // `Span` before impl block closing brace.
2370     let hi = full_impl_span.hi() - BytePos(1);
2371     // Point at the place right before the closing brace of the relevant `impl` to suggest
2372     // adding the associated item at the end of its body.
2373     let sugg_sp = full_impl_span.with_lo(hi).with_hi(hi);
2374     // Obtain the level of indentation ending in `sugg_sp`.
2375     let indentation = tcx.sess.source_map().span_to_margin(sugg_sp).unwrap_or(0);
2376     // Make the whitespace that will make the suggestion have the right indentation.
2377     let padding: String = (0..indentation).map(|_| " ").collect();
2378
2379     for trait_item in missing_items {
2380         let snippet = suggestion_signature(&trait_item, tcx);
2381         let code = format!("{}{}\n{}", padding, snippet, padding);
2382         let msg = format!("implement the missing item: `{}`", snippet);
2383         let appl = Applicability::HasPlaceholders;
2384         if let Some(span) = tcx.hir().span_if_local(trait_item.def_id) {
2385             err.span_label(span, format!("`{}` from trait", trait_item.ident));
2386             err.tool_only_span_suggestion(sugg_sp, &msg, code, appl);
2387         } else {
2388             err.span_suggestion_hidden(sugg_sp, &msg, code, appl);
2389         }
2390     }
2391     err.emit();
2392 }
2393
2394 /// Resugar `ty::GenericPredicates` in a way suitable to be used in structured suggestions.
2395 fn bounds_from_generic_predicates<'tcx>(
2396     tcx: TyCtxt<'tcx>,
2397     predicates: ty::GenericPredicates<'tcx>,
2398 ) -> (String, String) {
2399     let mut types: FxHashMap<Ty<'tcx>, Vec<DefId>> = FxHashMap::default();
2400     let mut projections = vec![];
2401     for (predicate, _) in predicates.predicates {
2402         debug!("predicate {:?}", predicate);
2403         match predicate.skip_binders() {
2404             ty::PredicateAtom::Trait(trait_predicate, _) => {
2405                 let entry = types.entry(trait_predicate.self_ty()).or_default();
2406                 let def_id = trait_predicate.def_id();
2407                 if Some(def_id) != tcx.lang_items().sized_trait() {
2408                     // Type params are `Sized` by default, do not add that restriction to the list
2409                     // if it is a positive requirement.
2410                     entry.push(trait_predicate.def_id());
2411                 }
2412             }
2413             ty::PredicateAtom::Projection(projection_pred) => {
2414                 projections.push(ty::Binder::bind(projection_pred));
2415             }
2416             _ => {}
2417         }
2418     }
2419     let generics = if types.is_empty() {
2420         "".to_string()
2421     } else {
2422         format!(
2423             "<{}>",
2424             types
2425                 .keys()
2426                 .filter_map(|t| match t.kind {
2427                     ty::Param(_) => Some(t.to_string()),
2428                     // Avoid suggesting the following:
2429                     // fn foo<T, <T as Trait>::Bar>(_: T) where T: Trait, <T as Trait>::Bar: Other {}
2430                     _ => None,
2431                 })
2432                 .collect::<Vec<_>>()
2433                 .join(", ")
2434         )
2435     };
2436     let mut where_clauses = vec![];
2437     for (ty, bounds) in types {
2438         for bound in &bounds {
2439             where_clauses.push(format!("{}: {}", ty, tcx.def_path_str(*bound)));
2440         }
2441     }
2442     for projection in &projections {
2443         let p = projection.skip_binder();
2444         // FIXME: this is not currently supported syntax, we should be looking at the `types` and
2445         // insert the associated types where they correspond, but for now let's be "lazy" and
2446         // propose this instead of the following valid resugaring:
2447         // `T: Trait, Trait::Assoc = K` â†’ `T: Trait<Assoc = K>`
2448         where_clauses.push(format!("{} = {}", tcx.def_path_str(p.projection_ty.item_def_id), p.ty));
2449     }
2450     let where_clauses = if where_clauses.is_empty() {
2451         String::new()
2452     } else {
2453         format!(" where {}", where_clauses.join(", "))
2454     };
2455     (generics, where_clauses)
2456 }
2457
2458 /// Return placeholder code for the given function.
2459 fn fn_sig_suggestion<'tcx>(
2460     tcx: TyCtxt<'tcx>,
2461     sig: ty::FnSig<'tcx>,
2462     ident: Ident,
2463     predicates: ty::GenericPredicates<'tcx>,
2464     assoc: &ty::AssocItem,
2465 ) -> String {
2466     let args = sig
2467         .inputs()
2468         .iter()
2469         .enumerate()
2470         .map(|(i, ty)| {
2471             Some(match ty.kind {
2472                 ty::Param(_) if assoc.fn_has_self_parameter && i == 0 => "self".to_string(),
2473                 ty::Ref(reg, ref_ty, mutability) if i == 0 => {
2474                     let reg = match &format!("{}", reg)[..] {
2475                         "'_" | "" => String::new(),
2476                         reg => format!("{} ", reg),
2477                     };
2478                     if assoc.fn_has_self_parameter {
2479                         match ref_ty.kind {
2480                             ty::Param(param) if param.name == kw::SelfUpper => {
2481                                 format!("&{}{}self", reg, mutability.prefix_str())
2482                             }
2483
2484                             _ => format!("self: {}", ty),
2485                         }
2486                     } else {
2487                         format!("_: {:?}", ty)
2488                     }
2489                 }
2490                 _ => {
2491                     if assoc.fn_has_self_parameter && i == 0 {
2492                         format!("self: {:?}", ty)
2493                     } else {
2494                         format!("_: {:?}", ty)
2495                     }
2496                 }
2497             })
2498         })
2499         .chain(std::iter::once(if sig.c_variadic { Some("...".to_string()) } else { None }))
2500         .filter_map(|arg| arg)
2501         .collect::<Vec<String>>()
2502         .join(", ");
2503     let output = sig.output();
2504     let output = if !output.is_unit() { format!(" -> {:?}", output) } else { String::new() };
2505
2506     let unsafety = sig.unsafety.prefix_str();
2507     let (generics, where_clauses) = bounds_from_generic_predicates(tcx, predicates);
2508
2509     // FIXME: this is not entirely correct, as the lifetimes from borrowed params will
2510     // not be present in the `fn` definition, not will we account for renamed
2511     // lifetimes between the `impl` and the `trait`, but this should be good enough to
2512     // fill in a significant portion of the missing code, and other subsequent
2513     // suggestions can help the user fix the code.
2514     format!(
2515         "{}fn {}{}({}){}{} {{ todo!() }}",
2516         unsafety, ident, generics, args, output, where_clauses
2517     )
2518 }
2519
2520 /// Return placeholder code for the given associated item.
2521 /// Similar to `ty::AssocItem::suggestion`, but appropriate for use as the code snippet of a
2522 /// structured suggestion.
2523 fn suggestion_signature(assoc: &ty::AssocItem, tcx: TyCtxt<'_>) -> String {
2524     match assoc.kind {
2525         ty::AssocKind::Fn => {
2526             // We skip the binder here because the binder would deanonymize all
2527             // late-bound regions, and we don't want method signatures to show up
2528             // `as for<'r> fn(&'r MyType)`.  Pretty-printing handles late-bound
2529             // regions just fine, showing `fn(&MyType)`.
2530             fn_sig_suggestion(
2531                 tcx,
2532                 tcx.fn_sig(assoc.def_id).skip_binder(),
2533                 assoc.ident,
2534                 tcx.predicates_of(assoc.def_id),
2535                 assoc,
2536             )
2537         }
2538         ty::AssocKind::Type => format!("type {} = Type;", assoc.ident),
2539         ty::AssocKind::Const => {
2540             let ty = tcx.type_of(assoc.def_id);
2541             let val = expr::ty_kind_suggestion(ty).unwrap_or("value");
2542             format!("const {}: {:?} = {};", assoc.ident, ty, val)
2543         }
2544     }
2545 }
2546
2547 /// Checks whether a type can be represented in memory. In particular, it
2548 /// identifies types that contain themselves without indirection through a
2549 /// pointer, which would mean their size is unbounded.
2550 fn check_representable(tcx: TyCtxt<'_>, sp: Span, item_def_id: LocalDefId) -> bool {
2551     let rty = tcx.type_of(item_def_id);
2552
2553     // Check that it is possible to represent this type. This call identifies
2554     // (1) types that contain themselves and (2) types that contain a different
2555     // recursive type. It is only necessary to throw an error on those that
2556     // contain themselves. For case 2, there must be an inner type that will be
2557     // caught by case 1.
2558     match rty.is_representable(tcx, sp) {
2559         Representability::SelfRecursive(spans) => {
2560             recursive_type_with_infinite_size_error(tcx, item_def_id.to_def_id(), spans);
2561             return false;
2562         }
2563         Representability::Representable | Representability::ContainsRecursive => (),
2564     }
2565     true
2566 }
2567
2568 pub fn check_simd(tcx: TyCtxt<'_>, sp: Span, def_id: LocalDefId) {
2569     let t = tcx.type_of(def_id);
2570     if let ty::Adt(def, substs) = t.kind {
2571         if def.is_struct() {
2572             let fields = &def.non_enum_variant().fields;
2573             if fields.is_empty() {
2574                 struct_span_err!(tcx.sess, sp, E0075, "SIMD vector cannot be empty").emit();
2575                 return;
2576             }
2577             let e = fields[0].ty(tcx, substs);
2578             if !fields.iter().all(|f| f.ty(tcx, substs) == e) {
2579                 struct_span_err!(tcx.sess, sp, E0076, "SIMD vector should be homogeneous")
2580                     .span_label(sp, "SIMD elements must have the same type")
2581                     .emit();
2582                 return;
2583             }
2584             match e.kind {
2585                 ty::Param(_) => { /* struct<T>(T, T, T, T) is ok */ }
2586                 _ if e.is_machine() => { /* struct(u8, u8, u8, u8) is ok */ }
2587                 _ => {
2588                     struct_span_err!(
2589                         tcx.sess,
2590                         sp,
2591                         E0077,
2592                         "SIMD vector element type should be machine type"
2593                     )
2594                     .emit();
2595                     return;
2596                 }
2597             }
2598         }
2599     }
2600 }
2601
2602 fn check_packed(tcx: TyCtxt<'_>, sp: Span, def: &ty::AdtDef) {
2603     let repr = def.repr;
2604     if repr.packed() {
2605         for attr in tcx.get_attrs(def.did).iter() {
2606             for r in attr::find_repr_attrs(&tcx.sess.parse_sess, attr) {
2607                 if let attr::ReprPacked(pack) = r {
2608                     if let Some(repr_pack) = repr.pack {
2609                         if pack as u64 != repr_pack.bytes() {
2610                             struct_span_err!(
2611                                 tcx.sess,
2612                                 sp,
2613                                 E0634,
2614                                 "type has conflicting packed representation hints"
2615                             )
2616                             .emit();
2617                         }
2618                     }
2619                 }
2620             }
2621         }
2622         if repr.align.is_some() {
2623             struct_span_err!(
2624                 tcx.sess,
2625                 sp,
2626                 E0587,
2627                 "type has conflicting packed and align representation hints"
2628             )
2629             .emit();
2630         } else {
2631             if let Some(def_spans) = check_packed_inner(tcx, def.did, &mut vec![]) {
2632                 let mut err = struct_span_err!(
2633                     tcx.sess,
2634                     sp,
2635                     E0588,
2636                     "packed type cannot transitively contain a `#[repr(align)]` type"
2637                 );
2638
2639                 err.span_note(
2640                     tcx.def_span(def_spans[0].0),
2641                     &format!(
2642                         "`{}` has a `#[repr(align)]` attribute",
2643                         tcx.item_name(def_spans[0].0)
2644                     ),
2645                 );
2646
2647                 if def_spans.len() > 2 {
2648                     let mut first = true;
2649                     for (adt_def, span) in def_spans.iter().skip(1).rev() {
2650                         let ident = tcx.item_name(*adt_def);
2651                         err.span_note(
2652                             *span,
2653                             &if first {
2654                                 format!(
2655                                     "`{}` contains a field of type `{}`",
2656                                     tcx.type_of(def.did),
2657                                     ident
2658                                 )
2659                             } else {
2660                                 format!("...which contains a field of type `{}`", ident)
2661                             },
2662                         );
2663                         first = false;
2664                     }
2665                 }
2666
2667                 err.emit();
2668             }
2669         }
2670     }
2671 }
2672
2673 fn check_packed_inner(
2674     tcx: TyCtxt<'_>,
2675     def_id: DefId,
2676     stack: &mut Vec<DefId>,
2677 ) -> Option<Vec<(DefId, Span)>> {
2678     if let ty::Adt(def, substs) = tcx.type_of(def_id).kind {
2679         if def.is_struct() || def.is_union() {
2680             if def.repr.align.is_some() {
2681                 return Some(vec![(def.did, DUMMY_SP)]);
2682             }
2683
2684             stack.push(def_id);
2685             for field in &def.non_enum_variant().fields {
2686                 if let ty::Adt(def, _) = field.ty(tcx, substs).kind {
2687                     if !stack.contains(&def.did) {
2688                         if let Some(mut defs) = check_packed_inner(tcx, def.did, stack) {
2689                             defs.push((def.did, field.ident.span));
2690                             return Some(defs);
2691                         }
2692                     }
2693                 }
2694             }
2695             stack.pop();
2696         }
2697     }
2698
2699     None
2700 }
2701
2702 /// Emit an error when encountering more or less than one variant in a transparent enum.
2703 fn bad_variant_count<'tcx>(tcx: TyCtxt<'tcx>, adt: &'tcx ty::AdtDef, sp: Span, did: DefId) {
2704     let variant_spans: Vec<_> = adt
2705         .variants
2706         .iter()
2707         .map(|variant| tcx.hir().span_if_local(variant.def_id).unwrap())
2708         .collect();
2709     let msg = format!("needs exactly one variant, but has {}", adt.variants.len(),);
2710     let mut err = struct_span_err!(tcx.sess, sp, E0731, "transparent enum {}", msg);
2711     err.span_label(sp, &msg);
2712     if let [start @ .., end] = &*variant_spans {
2713         for variant_span in start {
2714             err.span_label(*variant_span, "");
2715         }
2716         err.span_label(*end, &format!("too many variants in `{}`", tcx.def_path_str(did)));
2717     }
2718     err.emit();
2719 }
2720
2721 /// Emit an error when encountering more or less than one non-zero-sized field in a transparent
2722 /// enum.
2723 fn bad_non_zero_sized_fields<'tcx>(
2724     tcx: TyCtxt<'tcx>,
2725     adt: &'tcx ty::AdtDef,
2726     field_count: usize,
2727     field_spans: impl Iterator<Item = Span>,
2728     sp: Span,
2729 ) {
2730     let msg = format!("needs exactly one non-zero-sized field, but has {}", field_count);
2731     let mut err = struct_span_err!(
2732         tcx.sess,
2733         sp,
2734         E0690,
2735         "{}transparent {} {}",
2736         if adt.is_enum() { "the variant of a " } else { "" },
2737         adt.descr(),
2738         msg,
2739     );
2740     err.span_label(sp, &msg);
2741     for sp in field_spans {
2742         err.span_label(sp, "this field is non-zero-sized");
2743     }
2744     err.emit();
2745 }
2746
2747 fn check_transparent<'tcx>(tcx: TyCtxt<'tcx>, sp: Span, adt: &'tcx ty::AdtDef) {
2748     if !adt.repr.transparent() {
2749         return;
2750     }
2751     let sp = tcx.sess.source_map().guess_head_span(sp);
2752
2753     if adt.is_union() && !tcx.features().transparent_unions {
2754         feature_err(
2755             &tcx.sess.parse_sess,
2756             sym::transparent_unions,
2757             sp,
2758             "transparent unions are unstable",
2759         )
2760         .emit();
2761     }
2762
2763     if adt.variants.len() != 1 {
2764         bad_variant_count(tcx, adt, sp, adt.did);
2765         if adt.variants.is_empty() {
2766             // Don't bother checking the fields. No variants (and thus no fields) exist.
2767             return;
2768         }
2769     }
2770
2771     // For each field, figure out if it's known to be a ZST and align(1)
2772     let field_infos = adt.all_fields().map(|field| {
2773         let ty = field.ty(tcx, InternalSubsts::identity_for_item(tcx, field.did));
2774         let param_env = tcx.param_env(field.did);
2775         let layout = tcx.layout_of(param_env.and(ty));
2776         // We are currently checking the type this field came from, so it must be local
2777         let span = tcx.hir().span_if_local(field.did).unwrap();
2778         let zst = layout.map(|layout| layout.is_zst()).unwrap_or(false);
2779         let align1 = layout.map(|layout| layout.align.abi.bytes() == 1).unwrap_or(false);
2780         (span, zst, align1)
2781     });
2782
2783     let non_zst_fields =
2784         field_infos.clone().filter_map(|(span, zst, _align1)| if !zst { Some(span) } else { None });
2785     let non_zst_count = non_zst_fields.clone().count();
2786     if non_zst_count != 1 {
2787         bad_non_zero_sized_fields(tcx, adt, non_zst_count, non_zst_fields, sp);
2788     }
2789     for (span, zst, align1) in field_infos {
2790         if zst && !align1 {
2791             struct_span_err!(
2792                 tcx.sess,
2793                 span,
2794                 E0691,
2795                 "zero-sized field in transparent {} has alignment larger than 1",
2796                 adt.descr(),
2797             )
2798             .span_label(span, "has alignment larger than 1")
2799             .emit();
2800         }
2801     }
2802 }
2803
2804 #[allow(trivial_numeric_casts)]
2805 pub fn check_enum<'tcx>(
2806     tcx: TyCtxt<'tcx>,
2807     sp: Span,
2808     vs: &'tcx [hir::Variant<'tcx>],
2809     id: hir::HirId,
2810 ) {
2811     let def_id = tcx.hir().local_def_id(id);
2812     let def = tcx.adt_def(def_id);
2813     def.destructor(tcx); // force the destructor to be evaluated
2814
2815     if vs.is_empty() {
2816         let attributes = tcx.get_attrs(def_id.to_def_id());
2817         if let Some(attr) = attr::find_by_name(&attributes, sym::repr) {
2818             struct_span_err!(
2819                 tcx.sess,
2820                 attr.span,
2821                 E0084,
2822                 "unsupported representation for zero-variant enum"
2823             )
2824             .span_label(sp, "zero-variant enum")
2825             .emit();
2826         }
2827     }
2828
2829     let repr_type_ty = def.repr.discr_type().to_ty(tcx);
2830     if repr_type_ty == tcx.types.i128 || repr_type_ty == tcx.types.u128 {
2831         if !tcx.features().repr128 {
2832             feature_err(
2833                 &tcx.sess.parse_sess,
2834                 sym::repr128,
2835                 sp,
2836                 "repr with 128-bit type is unstable",
2837             )
2838             .emit();
2839         }
2840     }
2841
2842     for v in vs {
2843         if let Some(ref e) = v.disr_expr {
2844             tcx.ensure().typeck(tcx.hir().local_def_id(e.hir_id));
2845         }
2846     }
2847
2848     if tcx.adt_def(def_id).repr.int.is_none() && tcx.features().arbitrary_enum_discriminant {
2849         let is_unit = |var: &hir::Variant<'_>| match var.data {
2850             hir::VariantData::Unit(..) => true,
2851             _ => false,
2852         };
2853
2854         let has_disr = |var: &hir::Variant<'_>| var.disr_expr.is_some();
2855         let has_non_units = vs.iter().any(|var| !is_unit(var));
2856         let disr_units = vs.iter().any(|var| is_unit(&var) && has_disr(&var));
2857         let disr_non_unit = vs.iter().any(|var| !is_unit(&var) && has_disr(&var));
2858
2859         if disr_non_unit || (disr_units && has_non_units) {
2860             let mut err =
2861                 struct_span_err!(tcx.sess, sp, E0732, "`#[repr(inttype)]` must be specified");
2862             err.emit();
2863         }
2864     }
2865
2866     let mut disr_vals: Vec<Discr<'tcx>> = Vec::with_capacity(vs.len());
2867     for ((_, discr), v) in def.discriminants(tcx).zip(vs) {
2868         // Check for duplicate discriminant values
2869         if let Some(i) = disr_vals.iter().position(|&x| x.val == discr.val) {
2870             let variant_did = def.variants[VariantIdx::new(i)].def_id;
2871             let variant_i_hir_id = tcx.hir().as_local_hir_id(variant_did.expect_local());
2872             let variant_i = tcx.hir().expect_variant(variant_i_hir_id);
2873             let i_span = match variant_i.disr_expr {
2874                 Some(ref expr) => tcx.hir().span(expr.hir_id),
2875                 None => tcx.hir().span(variant_i_hir_id),
2876             };
2877             let span = match v.disr_expr {
2878                 Some(ref expr) => tcx.hir().span(expr.hir_id),
2879                 None => v.span,
2880             };
2881             struct_span_err!(
2882                 tcx.sess,
2883                 span,
2884                 E0081,
2885                 "discriminant value `{}` already exists",
2886                 disr_vals[i]
2887             )
2888             .span_label(i_span, format!("first use of `{}`", disr_vals[i]))
2889             .span_label(span, format!("enum already has `{}`", disr_vals[i]))
2890             .emit();
2891         }
2892         disr_vals.push(discr);
2893     }
2894
2895     check_representable(tcx, sp, def_id);
2896     check_transparent(tcx, sp, def);
2897 }
2898
2899 fn report_unexpected_variant_res(tcx: TyCtxt<'_>, res: Res, span: Span) {
2900     struct_span_err!(
2901         tcx.sess,
2902         span,
2903         E0533,
2904         "expected unit struct, unit variant or constant, found {}{}",
2905         res.descr(),
2906         tcx.sess.source_map().span_to_snippet(span).map_or(String::new(), |s| format!(" `{}`", s)),
2907     )
2908     .emit();
2909 }
2910
2911 impl<'a, 'tcx> AstConv<'tcx> for FnCtxt<'a, 'tcx> {
2912     fn tcx<'b>(&'b self) -> TyCtxt<'tcx> {
2913         self.tcx
2914     }
2915
2916     fn item_def_id(&self) -> Option<DefId> {
2917         None
2918     }
2919
2920     fn default_constness_for_trait_bounds(&self) -> hir::Constness {
2921         // FIXME: refactor this into a method
2922         let node = self.tcx.hir().get(self.body_id);
2923         if let Some(fn_like) = FnLikeNode::from_node(node) {
2924             fn_like.constness()
2925         } else {
2926             hir::Constness::NotConst
2927         }
2928     }
2929
2930     fn get_type_parameter_bounds(&self, _: Span, def_id: DefId) -> ty::GenericPredicates<'tcx> {
2931         let tcx = self.tcx;
2932         let hir_id = tcx.hir().as_local_hir_id(def_id.expect_local());
2933         let item_id = tcx.hir().ty_param_owner(hir_id);
2934         let item_def_id = tcx.hir().local_def_id(item_id);
2935         let generics = tcx.generics_of(item_def_id);
2936         let index = generics.param_def_id_to_index[&def_id];
2937         ty::GenericPredicates {
2938             parent: None,
2939             predicates: tcx.arena.alloc_from_iter(
2940                 self.param_env.caller_bounds().iter().filter_map(|predicate| {
2941                     match predicate.skip_binders() {
2942                         ty::PredicateAtom::Trait(data, _)
2943                             if data.self_ty().is_param(index) =>
2944                         {
2945                             // HACK(eddyb) should get the original `Span`.
2946                             let span = tcx.def_span(def_id);
2947                             Some((predicate, span))
2948                         }
2949                         _ => None,
2950                     }
2951                 }),
2952             ),
2953         }
2954     }
2955
2956     fn re_infer(&self, def: Option<&ty::GenericParamDef>, span: Span) -> Option<ty::Region<'tcx>> {
2957         let v = match def {
2958             Some(def) => infer::EarlyBoundRegion(span, def.name),
2959             None => infer::MiscVariable(span),
2960         };
2961         Some(self.next_region_var(v))
2962     }
2963
2964     fn allow_ty_infer(&self) -> bool {
2965         true
2966     }
2967
2968     fn ty_infer(&self, param: Option<&ty::GenericParamDef>, span: Span) -> Ty<'tcx> {
2969         if let Some(param) = param {
2970             if let GenericArgKind::Type(ty) = self.var_for_def(span, param).unpack() {
2971                 return ty;
2972             }
2973             unreachable!()
2974         } else {
2975             self.next_ty_var(TypeVariableOrigin {
2976                 kind: TypeVariableOriginKind::TypeInference,
2977                 span,
2978             })
2979         }
2980     }
2981
2982     fn ct_infer(
2983         &self,
2984         ty: Ty<'tcx>,
2985         param: Option<&ty::GenericParamDef>,
2986         span: Span,
2987     ) -> &'tcx Const<'tcx> {
2988         if let Some(param) = param {
2989             if let GenericArgKind::Const(ct) = self.var_for_def(span, param).unpack() {
2990                 return ct;
2991             }
2992             unreachable!()
2993         } else {
2994             self.next_const_var(
2995                 ty,
2996                 ConstVariableOrigin { kind: ConstVariableOriginKind::ConstInference, span },
2997             )
2998         }
2999     }
3000
3001     fn projected_ty_from_poly_trait_ref(
3002         &self,
3003         span: Span,
3004         item_def_id: DefId,
3005         item_segment: &hir::PathSegment<'_>,
3006         poly_trait_ref: ty::PolyTraitRef<'tcx>,
3007     ) -> Ty<'tcx> {
3008         let (trait_ref, _) = self.replace_bound_vars_with_fresh_vars(
3009             span,
3010             infer::LateBoundRegionConversionTime::AssocTypeProjection(item_def_id),
3011             &poly_trait_ref,
3012         );
3013
3014         let item_substs = <dyn AstConv<'tcx>>::create_substs_for_associated_item(
3015             self,
3016             self.tcx,
3017             span,
3018             item_def_id,
3019             item_segment,
3020             trait_ref.substs,
3021         );
3022
3023         self.tcx().mk_projection(item_def_id, item_substs)
3024     }
3025
3026     fn normalize_ty(&self, span: Span, ty: Ty<'tcx>) -> Ty<'tcx> {
3027         if ty.has_escaping_bound_vars() {
3028             ty // FIXME: normalization and escaping regions
3029         } else {
3030             self.normalize_associated_types_in(span, &ty)
3031         }
3032     }
3033
3034     fn set_tainted_by_errors(&self) {
3035         self.infcx.set_tainted_by_errors()
3036     }
3037
3038     fn record_ty(&self, hir_id: hir::HirId, ty: Ty<'tcx>, _span: Span) {
3039         self.write_ty(hir_id, ty)
3040     }
3041 }
3042
3043 /// Controls whether the arguments are tupled. This is used for the call
3044 /// operator.
3045 ///
3046 /// Tupling means that all call-side arguments are packed into a tuple and
3047 /// passed as a single parameter. For example, if tupling is enabled, this
3048 /// function:
3049 ///
3050 ///     fn f(x: (isize, isize))
3051 ///
3052 /// Can be called as:
3053 ///
3054 ///     f(1, 2);
3055 ///
3056 /// Instead of:
3057 ///
3058 ///     f((1, 2));
3059 #[derive(Clone, Eq, PartialEq)]
3060 enum TupleArgumentsFlag {
3061     DontTupleArguments,
3062     TupleArguments,
3063 }
3064
3065 /// Controls how we perform fallback for unconstrained
3066 /// type variables.
3067 enum FallbackMode {
3068     /// Do not fallback type variables to opaque types.
3069     NoOpaque,
3070     /// Perform all possible kinds of fallback, including
3071     /// turning type variables to opaque types.
3072     All,
3073 }
3074
3075 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
3076     pub fn new(
3077         inh: &'a Inherited<'a, 'tcx>,
3078         param_env: ty::ParamEnv<'tcx>,
3079         body_id: hir::HirId,
3080     ) -> FnCtxt<'a, 'tcx> {
3081         FnCtxt {
3082             body_id,
3083             param_env,
3084             err_count_on_creation: inh.tcx.sess.err_count(),
3085             ret_coercion: None,
3086             ret_coercion_span: RefCell::new(None),
3087             resume_yield_tys: None,
3088             ps: RefCell::new(UnsafetyState::function(hir::Unsafety::Normal, hir::CRATE_HIR_ID)),
3089             diverges: Cell::new(Diverges::Maybe),
3090             has_errors: Cell::new(false),
3091             enclosing_breakables: RefCell::new(EnclosingBreakables {
3092                 stack: Vec::new(),
3093                 by_id: Default::default(),
3094             }),
3095             inh,
3096         }
3097     }
3098
3099     pub fn sess(&self) -> &Session {
3100         &self.tcx.sess
3101     }
3102
3103     pub fn errors_reported_since_creation(&self) -> bool {
3104         self.tcx.sess.err_count() > self.err_count_on_creation
3105     }
3106
3107     /// Produces warning on the given node, if the current point in the
3108     /// function is unreachable, and there hasn't been another warning.
3109     fn warn_if_unreachable(&self, id: hir::HirId, span: Span, kind: &str) {
3110         // FIXME: Combine these two 'if' expressions into one once
3111         // let chains are implemented
3112         if let Diverges::Always { span: orig_span, custom_note } = self.diverges.get() {
3113             // If span arose from a desugaring of `if` or `while`, then it is the condition itself,
3114             // which diverges, that we are about to lint on. This gives suboptimal diagnostics.
3115             // Instead, stop here so that the `if`- or `while`-expression's block is linted instead.
3116             if !span.is_desugaring(DesugaringKind::CondTemporary)
3117                 && !span.is_desugaring(DesugaringKind::Async)
3118                 && !orig_span.is_desugaring(DesugaringKind::Await)
3119             {
3120                 self.diverges.set(Diverges::WarnedAlways);
3121
3122                 debug!("warn_if_unreachable: id={:?} span={:?} kind={}", id, span, kind);
3123
3124                 self.tcx().struct_span_lint_hir(lint::builtin::UNREACHABLE_CODE, id, span, |lint| {
3125                     let msg = format!("unreachable {}", kind);
3126                     lint.build(&msg)
3127                         .span_label(span, &msg)
3128                         .span_label(
3129                             orig_span,
3130                             custom_note
3131                                 .unwrap_or("any code following this expression is unreachable"),
3132                         )
3133                         .emit();
3134                 })
3135             }
3136         }
3137     }
3138
3139     pub fn cause(&self, span: Span, code: ObligationCauseCode<'tcx>) -> ObligationCause<'tcx> {
3140         ObligationCause::new(span, self.body_id, code)
3141     }
3142
3143     pub fn misc(&self, span: Span) -> ObligationCause<'tcx> {
3144         self.cause(span, ObligationCauseCode::MiscObligation)
3145     }
3146
3147     /// Resolves type and const variables in `ty` if possible. Unlike the infcx
3148     /// version (resolve_vars_if_possible), this version will
3149     /// also select obligations if it seems useful, in an effort
3150     /// to get more type information.
3151     fn resolve_vars_with_obligations(&self, mut ty: Ty<'tcx>) -> Ty<'tcx> {
3152         debug!("resolve_vars_with_obligations(ty={:?})", ty);
3153
3154         // No Infer()? Nothing needs doing.
3155         if !ty.has_infer_types_or_consts() {
3156             debug!("resolve_vars_with_obligations: ty={:?}", ty);
3157             return ty;
3158         }
3159
3160         // If `ty` is a type variable, see whether we already know what it is.
3161         ty = self.resolve_vars_if_possible(&ty);
3162         if !ty.has_infer_types_or_consts() {
3163             debug!("resolve_vars_with_obligations: ty={:?}", ty);
3164             return ty;
3165         }
3166
3167         // If not, try resolving pending obligations as much as
3168         // possible. This can help substantially when there are
3169         // indirect dependencies that don't seem worth tracking
3170         // precisely.
3171         self.select_obligations_where_possible(false, |_| {});
3172         ty = self.resolve_vars_if_possible(&ty);
3173
3174         debug!("resolve_vars_with_obligations: ty={:?}", ty);
3175         ty
3176     }
3177
3178     fn record_deferred_call_resolution(
3179         &self,
3180         closure_def_id: DefId,
3181         r: DeferredCallResolution<'tcx>,
3182     ) {
3183         let mut deferred_call_resolutions = self.deferred_call_resolutions.borrow_mut();
3184         deferred_call_resolutions.entry(closure_def_id).or_default().push(r);
3185     }
3186
3187     fn remove_deferred_call_resolutions(
3188         &self,
3189         closure_def_id: DefId,
3190     ) -> Vec<DeferredCallResolution<'tcx>> {
3191         let mut deferred_call_resolutions = self.deferred_call_resolutions.borrow_mut();
3192         deferred_call_resolutions.remove(&closure_def_id).unwrap_or(vec![])
3193     }
3194
3195     pub fn tag(&self) -> String {
3196         format!("{:p}", self)
3197     }
3198
3199     pub fn local_ty(&self, span: Span, nid: hir::HirId) -> LocalTy<'tcx> {
3200         self.locals.borrow().get(&nid).cloned().unwrap_or_else(|| {
3201             span_bug!(span, "no type for local variable {}", self.tcx.hir().node_to_string(nid))
3202         })
3203     }
3204
3205     #[inline]
3206     pub fn write_ty(&self, id: hir::HirId, ty: Ty<'tcx>) {
3207         debug!(
3208             "write_ty({:?}, {:?}) in fcx {}",
3209             id,
3210             self.resolve_vars_if_possible(&ty),
3211             self.tag()
3212         );
3213         self.typeck_results.borrow_mut().node_types_mut().insert(id, ty);
3214
3215         if ty.references_error() {
3216             self.has_errors.set(true);
3217             self.set_tainted_by_errors();
3218         }
3219     }
3220
3221     pub fn write_field_index(&self, hir_id: hir::HirId, index: usize) {
3222         self.typeck_results.borrow_mut().field_indices_mut().insert(hir_id, index);
3223     }
3224
3225     fn write_resolution(&self, hir_id: hir::HirId, r: Result<(DefKind, DefId), ErrorReported>) {
3226         self.typeck_results.borrow_mut().type_dependent_defs_mut().insert(hir_id, r);
3227     }
3228
3229     pub fn write_method_call(&self, hir_id: hir::HirId, method: MethodCallee<'tcx>) {
3230         debug!("write_method_call(hir_id={:?}, method={:?})", hir_id, method);
3231         self.write_resolution(hir_id, Ok((DefKind::AssocFn, method.def_id)));
3232         self.write_substs(hir_id, method.substs);
3233
3234         // When the method is confirmed, the `method.substs` includes
3235         // parameters from not just the method, but also the impl of
3236         // the method -- in particular, the `Self` type will be fully
3237         // resolved. However, those are not something that the "user
3238         // specified" -- i.e., those types come from the inferred type
3239         // of the receiver, not something the user wrote. So when we
3240         // create the user-substs, we want to replace those earlier
3241         // types with just the types that the user actually wrote --
3242         // that is, those that appear on the *method itself*.
3243         //
3244         // As an example, if the user wrote something like
3245         // `foo.bar::<u32>(...)` -- the `Self` type here will be the
3246         // type of `foo` (possibly adjusted), but we don't want to
3247         // include that. We want just the `[_, u32]` part.
3248         if !method.substs.is_noop() {
3249             let method_generics = self.tcx.generics_of(method.def_id);
3250             if !method_generics.params.is_empty() {
3251                 let user_type_annotation = self.infcx.probe(|_| {
3252                     let user_substs = UserSubsts {
3253                         substs: InternalSubsts::for_item(self.tcx, method.def_id, |param, _| {
3254                             let i = param.index as usize;
3255                             if i < method_generics.parent_count {
3256                                 self.infcx.var_for_def(DUMMY_SP, param)
3257                             } else {
3258                                 method.substs[i]
3259                             }
3260                         }),
3261                         user_self_ty: None, // not relevant here
3262                     };
3263
3264                     self.infcx.canonicalize_user_type_annotation(&UserType::TypeOf(
3265                         method.def_id,
3266                         user_substs,
3267                     ))
3268                 });
3269
3270                 debug!("write_method_call: user_type_annotation={:?}", user_type_annotation);
3271                 self.write_user_type_annotation(hir_id, user_type_annotation);
3272             }
3273         }
3274     }
3275
3276     pub fn write_substs(&self, node_id: hir::HirId, substs: SubstsRef<'tcx>) {
3277         if !substs.is_noop() {
3278             debug!("write_substs({:?}, {:?}) in fcx {}", node_id, substs, self.tag());
3279
3280             self.typeck_results.borrow_mut().node_substs_mut().insert(node_id, substs);
3281         }
3282     }
3283
3284     /// Given the substs that we just converted from the HIR, try to
3285     /// canonicalize them and store them as user-given substitutions
3286     /// (i.e., substitutions that must be respected by the NLL check).
3287     ///
3288     /// This should be invoked **before any unifications have
3289     /// occurred**, so that annotations like `Vec<_>` are preserved
3290     /// properly.
3291     pub fn write_user_type_annotation_from_substs(
3292         &self,
3293         hir_id: hir::HirId,
3294         def_id: DefId,
3295         substs: SubstsRef<'tcx>,
3296         user_self_ty: Option<UserSelfTy<'tcx>>,
3297     ) {
3298         debug!(
3299             "write_user_type_annotation_from_substs: hir_id={:?} def_id={:?} substs={:?} \
3300              user_self_ty={:?} in fcx {}",
3301             hir_id,
3302             def_id,
3303             substs,
3304             user_self_ty,
3305             self.tag(),
3306         );
3307
3308         if Self::can_contain_user_lifetime_bounds((substs, user_self_ty)) {
3309             let canonicalized = self.infcx.canonicalize_user_type_annotation(&UserType::TypeOf(
3310                 def_id,
3311                 UserSubsts { substs, user_self_ty },
3312             ));
3313             debug!("write_user_type_annotation_from_substs: canonicalized={:?}", canonicalized);
3314             self.write_user_type_annotation(hir_id, canonicalized);
3315         }
3316     }
3317
3318     pub fn write_user_type_annotation(
3319         &self,
3320         hir_id: hir::HirId,
3321         canonical_user_type_annotation: CanonicalUserType<'tcx>,
3322     ) {
3323         debug!(
3324             "write_user_type_annotation: hir_id={:?} canonical_user_type_annotation={:?} tag={}",
3325             hir_id,
3326             canonical_user_type_annotation,
3327             self.tag(),
3328         );
3329
3330         if !canonical_user_type_annotation.is_identity() {
3331             self.typeck_results
3332                 .borrow_mut()
3333                 .user_provided_types_mut()
3334                 .insert(hir_id, canonical_user_type_annotation);
3335         } else {
3336             debug!("write_user_type_annotation: skipping identity substs");
3337         }
3338     }
3339
3340     pub fn apply_adjustments(&self, expr: &hir::Expr<'_>, adj: Vec<Adjustment<'tcx>>) {
3341         debug!("apply_adjustments(expr={:?}, adj={:?})", expr, adj);
3342
3343         if adj.is_empty() {
3344             return;
3345         }
3346
3347         let autoborrow_mut = adj.iter().any(|adj| {
3348             matches!(adj, &Adjustment {
3349                 kind: Adjust::Borrow(AutoBorrow::Ref(_, AutoBorrowMutability::Mut { .. })),
3350                 ..
3351             })
3352         });
3353
3354         match self.typeck_results.borrow_mut().adjustments_mut().entry(expr.hir_id) {
3355             Entry::Vacant(entry) => {
3356                 entry.insert(adj);
3357             }
3358             Entry::Occupied(mut entry) => {
3359                 debug!(" - composing on top of {:?}", entry.get());
3360                 match (&entry.get()[..], &adj[..]) {
3361                     // Applying any adjustment on top of a NeverToAny
3362                     // is a valid NeverToAny adjustment, because it can't
3363                     // be reached.
3364                     (&[Adjustment { kind: Adjust::NeverToAny, .. }], _) => return,
3365                     (&[
3366                         Adjustment { kind: Adjust::Deref(_), .. },
3367                         Adjustment { kind: Adjust::Borrow(AutoBorrow::Ref(..)), .. },
3368                     ], &[
3369                         Adjustment { kind: Adjust::Deref(_), .. },
3370                         .. // Any following adjustments are allowed.
3371                     ]) => {
3372                         // A reborrow has no effect before a dereference.
3373                     }
3374                     // FIXME: currently we never try to compose autoderefs
3375                     // and ReifyFnPointer/UnsafeFnPointer, but we could.
3376                     _ =>
3377                         bug!("while adjusting {:?}, can't compose {:?} and {:?}",
3378                              expr, entry.get(), adj)
3379                 };
3380                 *entry.get_mut() = adj;
3381             }
3382         }
3383
3384         // If there is an mutable auto-borrow, it is equivalent to `&mut <expr>`.
3385         // In this case implicit use of `Deref` and `Index` within `<expr>` should
3386         // instead be `DerefMut` and `IndexMut`, so fix those up.
3387         if autoborrow_mut {
3388             self.convert_place_derefs_to_mutable(expr);
3389         }
3390     }
3391
3392     /// Basically whenever we are converting from a type scheme into
3393     /// the fn body space, we always want to normalize associated
3394     /// types as well. This function combines the two.
3395     fn instantiate_type_scheme<T>(&self, span: Span, substs: SubstsRef<'tcx>, value: &T) -> T
3396     where
3397         T: TypeFoldable<'tcx>,
3398     {
3399         let value = value.subst(self.tcx, substs);
3400         let result = self.normalize_associated_types_in(span, &value);
3401         debug!("instantiate_type_scheme(value={:?}, substs={:?}) = {:?}", value, substs, result);
3402         result
3403     }
3404
3405     /// As `instantiate_type_scheme`, but for the bounds found in a
3406     /// generic type scheme.
3407     fn instantiate_bounds(
3408         &self,
3409         span: Span,
3410         def_id: DefId,
3411         substs: SubstsRef<'tcx>,
3412     ) -> (ty::InstantiatedPredicates<'tcx>, Vec<Span>) {
3413         let bounds = self.tcx.predicates_of(def_id);
3414         let spans: Vec<Span> = bounds.predicates.iter().map(|(_, span)| *span).collect();
3415         let result = bounds.instantiate(self.tcx, substs);
3416         let result = self.normalize_associated_types_in(span, &result);
3417         debug!(
3418             "instantiate_bounds(bounds={:?}, substs={:?}) = {:?}, {:?}",
3419             bounds, substs, result, spans,
3420         );
3421         (result, spans)
3422     }
3423
3424     /// Replaces the opaque types from the given value with type variables,
3425     /// and records the `OpaqueTypeMap` for later use during writeback. See
3426     /// `InferCtxt::instantiate_opaque_types` for more details.
3427     fn instantiate_opaque_types_from_value<T: TypeFoldable<'tcx>>(
3428         &self,
3429         parent_id: hir::HirId,
3430         value: &T,
3431         value_span: Span,
3432     ) -> T {
3433         let parent_def_id = self.tcx.hir().local_def_id(parent_id);
3434         debug!(
3435             "instantiate_opaque_types_from_value(parent_def_id={:?}, value={:?})",
3436             parent_def_id, value
3437         );
3438
3439         let (value, opaque_type_map) =
3440             self.register_infer_ok_obligations(self.instantiate_opaque_types(
3441                 parent_def_id,
3442                 self.body_id,
3443                 self.param_env,
3444                 value,
3445                 value_span,
3446             ));
3447
3448         let mut opaque_types = self.opaque_types.borrow_mut();
3449         let mut opaque_types_vars = self.opaque_types_vars.borrow_mut();
3450         for (ty, decl) in opaque_type_map {
3451             let _ = opaque_types.insert(ty, decl);
3452             let _ = opaque_types_vars.insert(decl.concrete_ty, decl.opaque_type);
3453         }
3454
3455         value
3456     }
3457
3458     fn normalize_associated_types_in<T>(&self, span: Span, value: &T) -> T
3459     where
3460         T: TypeFoldable<'tcx>,
3461     {
3462         self.inh.normalize_associated_types_in(span, self.body_id, self.param_env, value)
3463     }
3464
3465     fn normalize_associated_types_in_as_infer_ok<T>(
3466         &self,
3467         span: Span,
3468         value: &T,
3469     ) -> InferOk<'tcx, T>
3470     where
3471         T: TypeFoldable<'tcx>,
3472     {
3473         self.inh.partially_normalize_associated_types_in(span, self.body_id, self.param_env, value)
3474     }
3475
3476     pub fn require_type_meets(
3477         &self,
3478         ty: Ty<'tcx>,
3479         span: Span,
3480         code: traits::ObligationCauseCode<'tcx>,
3481         def_id: DefId,
3482     ) {
3483         self.register_bound(ty, def_id, traits::ObligationCause::new(span, self.body_id, code));
3484     }
3485
3486     pub fn require_type_is_sized(
3487         &self,
3488         ty: Ty<'tcx>,
3489         span: Span,
3490         code: traits::ObligationCauseCode<'tcx>,
3491     ) {
3492         if !ty.references_error() {
3493             let lang_item = self.tcx.require_lang_item(SizedTraitLangItem, None);
3494             self.require_type_meets(ty, span, code, lang_item);
3495         }
3496     }
3497
3498     pub fn require_type_is_sized_deferred(
3499         &self,
3500         ty: Ty<'tcx>,
3501         span: Span,
3502         code: traits::ObligationCauseCode<'tcx>,
3503     ) {
3504         if !ty.references_error() {
3505             self.deferred_sized_obligations.borrow_mut().push((ty, span, code));
3506         }
3507     }
3508
3509     pub fn register_bound(
3510         &self,
3511         ty: Ty<'tcx>,
3512         def_id: DefId,
3513         cause: traits::ObligationCause<'tcx>,
3514     ) {
3515         if !ty.references_error() {
3516             self.fulfillment_cx.borrow_mut().register_bound(
3517                 self,
3518                 self.param_env,
3519                 ty,
3520                 def_id,
3521                 cause,
3522             );
3523         }
3524     }
3525
3526     pub fn to_ty(&self, ast_t: &hir::Ty<'_>) -> Ty<'tcx> {
3527         let t = AstConv::ast_ty_to_ty(self, ast_t);
3528         self.register_wf_obligation(t.into(), ast_t.span, traits::MiscObligation);
3529         t
3530     }
3531
3532     pub fn to_ty_saving_user_provided_ty(&self, ast_ty: &hir::Ty<'_>) -> Ty<'tcx> {
3533         let ty = self.to_ty(ast_ty);
3534         debug!("to_ty_saving_user_provided_ty: ty={:?}", ty);
3535
3536         if Self::can_contain_user_lifetime_bounds(ty) {
3537             let c_ty = self.infcx.canonicalize_response(&UserType::Ty(ty));
3538             debug!("to_ty_saving_user_provided_ty: c_ty={:?}", c_ty);
3539             self.typeck_results.borrow_mut().user_provided_types_mut().insert(ast_ty.hir_id, c_ty);
3540         }
3541
3542         ty
3543     }
3544
3545     pub fn to_const(&self, ast_c: &hir::AnonConst) -> &'tcx ty::Const<'tcx> {
3546         let const_def_id = self.tcx.hir().local_def_id(ast_c.hir_id);
3547         let c = ty::Const::from_anon_const(self.tcx, const_def_id);
3548         self.register_wf_obligation(
3549             c.into(),
3550             self.tcx.hir().span(ast_c.hir_id),
3551             ObligationCauseCode::MiscObligation,
3552         );
3553         c
3554     }
3555
3556     pub fn const_arg_to_const(
3557         &self,
3558         ast_c: &hir::AnonConst,
3559         param_def_id: DefId,
3560     ) -> &'tcx ty::Const<'tcx> {
3561         let const_def = ty::WithOptConstParam {
3562             did: self.tcx.hir().local_def_id(ast_c.hir_id),
3563             const_param_did: Some(param_def_id),
3564         };
3565         let c = ty::Const::from_opt_const_arg_anon_const(self.tcx, const_def);
3566         self.register_wf_obligation(
3567             c.into(),
3568             self.tcx.hir().span(ast_c.hir_id),
3569             ObligationCauseCode::MiscObligation,
3570         );
3571         c
3572     }
3573
3574     // If the type given by the user has free regions, save it for later, since
3575     // NLL would like to enforce those. Also pass in types that involve
3576     // projections, since those can resolve to `'static` bounds (modulo #54940,
3577     // which hopefully will be fixed by the time you see this comment, dear
3578     // reader, although I have my doubts). Also pass in types with inference
3579     // types, because they may be repeated. Other sorts of things are already
3580     // sufficiently enforced with erased regions. =)
3581     fn can_contain_user_lifetime_bounds<T>(t: T) -> bool
3582     where
3583         T: TypeFoldable<'tcx>,
3584     {
3585         t.has_free_regions() || t.has_projections() || t.has_infer_types()
3586     }
3587
3588     pub fn node_ty(&self, id: hir::HirId) -> Ty<'tcx> {
3589         match self.typeck_results.borrow().node_types().get(id) {
3590             Some(&t) => t,
3591             None if self.is_tainted_by_errors() => self.tcx.ty_error(),
3592             None => {
3593                 bug!(
3594                     "no type for node {}: {} in fcx {}",
3595                     id,
3596                     self.tcx.hir().node_to_string(id),
3597                     self.tag()
3598                 );
3599             }
3600         }
3601     }
3602
3603     /// Registers an obligation for checking later, during regionck, that `arg` is well-formed.
3604     pub fn register_wf_obligation(
3605         &self,
3606         arg: subst::GenericArg<'tcx>,
3607         span: Span,
3608         code: traits::ObligationCauseCode<'tcx>,
3609     ) {
3610         // WF obligations never themselves fail, so no real need to give a detailed cause:
3611         let cause = traits::ObligationCause::new(span, self.body_id, code);
3612         self.register_predicate(traits::Obligation::new(
3613             cause,
3614             self.param_env,
3615             ty::PredicateAtom::WellFormed(arg).to_predicate(self.tcx),
3616         ));
3617     }
3618
3619     /// Registers obligations that all `substs` are well-formed.
3620     pub fn add_wf_bounds(&self, substs: SubstsRef<'tcx>, expr: &hir::Expr<'_>) {
3621         for arg in substs.iter().filter(|arg| {
3622             matches!(arg.unpack(), GenericArgKind::Type(..) | GenericArgKind::Const(..))
3623         }) {
3624             self.register_wf_obligation(arg, expr.span, traits::MiscObligation);
3625         }
3626     }
3627
3628     /// Given a fully substituted set of bounds (`generic_bounds`), and the values with which each
3629     /// type/region parameter was instantiated (`substs`), creates and registers suitable
3630     /// trait/region obligations.
3631     ///
3632     /// For example, if there is a function:
3633     ///
3634     /// ```
3635     /// fn foo<'a,T:'a>(...)
3636     /// ```
3637     ///
3638     /// and a reference:
3639     ///
3640     /// ```
3641     /// let f = foo;
3642     /// ```
3643     ///
3644     /// Then we will create a fresh region variable `'$0` and a fresh type variable `$1` for `'a`
3645     /// and `T`. This routine will add a region obligation `$1:'$0` and register it locally.
3646     pub fn add_obligations_for_parameters(
3647         &self,
3648         cause: traits::ObligationCause<'tcx>,
3649         predicates: ty::InstantiatedPredicates<'tcx>,
3650     ) {
3651         assert!(!predicates.has_escaping_bound_vars());
3652
3653         debug!("add_obligations_for_parameters(predicates={:?})", predicates);
3654
3655         for obligation in traits::predicates_for_generics(cause, self.param_env, predicates) {
3656             self.register_predicate(obligation);
3657         }
3658     }
3659
3660     // FIXME(arielb1): use this instead of field.ty everywhere
3661     // Only for fields! Returns <none> for methods>
3662     // Indifferent to privacy flags
3663     pub fn field_ty(
3664         &self,
3665         span: Span,
3666         field: &'tcx ty::FieldDef,
3667         substs: SubstsRef<'tcx>,
3668     ) -> Ty<'tcx> {
3669         self.normalize_associated_types_in(span, &field.ty(self.tcx, substs))
3670     }
3671
3672     fn check_casts(&self) {
3673         let mut deferred_cast_checks = self.deferred_cast_checks.borrow_mut();
3674         for cast in deferred_cast_checks.drain(..) {
3675             cast.check(self);
3676         }
3677     }
3678
3679     fn resolve_generator_interiors(&self, def_id: DefId) {
3680         let mut generators = self.deferred_generator_interiors.borrow_mut();
3681         for (body_id, interior, kind) in generators.drain(..) {
3682             self.select_obligations_where_possible(false, |_| {});
3683             generator_interior::resolve_interior(self, def_id, body_id, interior, kind);
3684         }
3685     }
3686
3687     // Tries to apply a fallback to `ty` if it is an unsolved variable.
3688     //
3689     // - Unconstrained ints are replaced with `i32`.
3690     //
3691     // - Unconstrained floats are replaced with with `f64`.
3692     //
3693     // - Non-numerics get replaced with `!` when `#![feature(never_type_fallback)]`
3694     //   is enabled. Otherwise, they are replaced with `()`.
3695     //
3696     // Fallback becomes very dubious if we have encountered type-checking errors.
3697     // In that case, fallback to Error.
3698     // The return value indicates whether fallback has occurred.
3699     fn fallback_if_possible(&self, ty: Ty<'tcx>, mode: FallbackMode) -> bool {
3700         use rustc_middle::ty::error::UnconstrainedNumeric::Neither;
3701         use rustc_middle::ty::error::UnconstrainedNumeric::{UnconstrainedFloat, UnconstrainedInt};
3702
3703         assert!(ty.is_ty_infer());
3704         let fallback = match self.type_is_unconstrained_numeric(ty) {
3705             _ if self.is_tainted_by_errors() => self.tcx().ty_error(),
3706             UnconstrainedInt => self.tcx.types.i32,
3707             UnconstrainedFloat => self.tcx.types.f64,
3708             Neither if self.type_var_diverges(ty) => self.tcx.mk_diverging_default(),
3709             Neither => {
3710                 // This type variable was created from the instantiation of an opaque
3711                 // type. The fact that we're attempting to perform fallback for it
3712                 // means that the function neither constrained it to a concrete
3713                 // type, nor to the opaque type itself.
3714                 //
3715                 // For example, in this code:
3716                 //
3717                 //```
3718                 // type MyType = impl Copy;
3719                 // fn defining_use() -> MyType { true }
3720                 // fn other_use() -> MyType { defining_use() }
3721                 // ```
3722                 //
3723                 // `defining_use` will constrain the instantiated inference
3724                 // variable to `bool`, while `other_use` will constrain
3725                 // the instantiated inference variable to `MyType`.
3726                 //
3727                 // When we process opaque types during writeback, we
3728                 // will handle cases like `other_use`, and not count
3729                 // them as defining usages
3730                 //
3731                 // However, we also need to handle cases like this:
3732                 //
3733                 // ```rust
3734                 // pub type Foo = impl Copy;
3735                 // fn produce() -> Option<Foo> {
3736                 //     None
3737                 //  }
3738                 //  ```
3739                 //
3740                 // In the above snippet, the inference variable created by
3741                 // instantiating `Option<Foo>` will be completely unconstrained.
3742                 // We treat this as a non-defining use by making the inference
3743                 // variable fall back to the opaque type itself.
3744                 if let FallbackMode::All = mode {
3745                     if let Some(opaque_ty) = self.opaque_types_vars.borrow().get(ty) {
3746                         debug!(
3747                             "fallback_if_possible: falling back opaque type var {:?} to {:?}",
3748                             ty, opaque_ty
3749                         );
3750                         *opaque_ty
3751                     } else {
3752                         return false;
3753                     }
3754                 } else {
3755                     return false;
3756                 }
3757             }
3758         };
3759         debug!("fallback_if_possible: defaulting `{:?}` to `{:?}`", ty, fallback);
3760         self.demand_eqtype(rustc_span::DUMMY_SP, ty, fallback);
3761         true
3762     }
3763
3764     fn select_all_obligations_or_error(&self) {
3765         debug!("select_all_obligations_or_error");
3766         if let Err(errors) = self.fulfillment_cx.borrow_mut().select_all_or_error(&self) {
3767             self.report_fulfillment_errors(&errors, self.inh.body_id, false);
3768         }
3769     }
3770
3771     /// Select as many obligations as we can at present.
3772     fn select_obligations_where_possible(
3773         &self,
3774         fallback_has_occurred: bool,
3775         mutate_fullfillment_errors: impl Fn(&mut Vec<traits::FulfillmentError<'tcx>>),
3776     ) {
3777         let result = self.fulfillment_cx.borrow_mut().select_where_possible(self);
3778         if let Err(mut errors) = result {
3779             mutate_fullfillment_errors(&mut errors);
3780             self.report_fulfillment_errors(&errors, self.inh.body_id, fallback_has_occurred);
3781         }
3782     }
3783
3784     /// For the overloaded place expressions (`*x`, `x[3]`), the trait
3785     /// returns a type of `&T`, but the actual type we assign to the
3786     /// *expression* is `T`. So this function just peels off the return
3787     /// type by one layer to yield `T`.
3788     fn make_overloaded_place_return_type(
3789         &self,
3790         method: MethodCallee<'tcx>,
3791     ) -> ty::TypeAndMut<'tcx> {
3792         // extract method return type, which will be &T;
3793         let ret_ty = method.sig.output();
3794
3795         // method returns &T, but the type as visible to user is T, so deref
3796         ret_ty.builtin_deref(true).unwrap()
3797     }
3798
3799     fn check_method_argument_types(
3800         &self,
3801         sp: Span,
3802         expr: &'tcx hir::Expr<'tcx>,
3803         method: Result<MethodCallee<'tcx>, ()>,
3804         args_no_rcvr: &'tcx [hir::Expr<'tcx>],
3805         tuple_arguments: TupleArgumentsFlag,
3806         expected: Expectation<'tcx>,
3807     ) -> Ty<'tcx> {
3808         let has_error = match method {
3809             Ok(method) => method.substs.references_error() || method.sig.references_error(),
3810             Err(_) => true,
3811         };
3812         if has_error {
3813             let err_inputs = self.err_args(args_no_rcvr.len());
3814
3815             let err_inputs = match tuple_arguments {
3816                 DontTupleArguments => err_inputs,
3817                 TupleArguments => vec![self.tcx.intern_tup(&err_inputs[..])],
3818             };
3819
3820             self.check_argument_types(
3821                 sp,
3822                 expr,
3823                 &err_inputs[..],
3824                 &[],
3825                 args_no_rcvr,
3826                 false,
3827                 tuple_arguments,
3828                 None,
3829             );
3830             return self.tcx.ty_error();
3831         }
3832
3833         let method = method.unwrap();
3834         // HACK(eddyb) ignore self in the definition (see above).
3835         let expected_arg_tys = self.expected_inputs_for_expected_output(
3836             sp,
3837             expected,
3838             method.sig.output(),
3839             &method.sig.inputs()[1..],
3840         );
3841         self.check_argument_types(
3842             sp,
3843             expr,
3844             &method.sig.inputs()[1..],
3845             &expected_arg_tys[..],
3846             args_no_rcvr,
3847             method.sig.c_variadic,
3848             tuple_arguments,
3849             self.tcx.hir().span_if_local(method.def_id),
3850         );
3851         method.sig.output()
3852     }
3853
3854     fn self_type_matches_expected_vid(
3855         &self,
3856         trait_ref: ty::PolyTraitRef<'tcx>,
3857         expected_vid: ty::TyVid,
3858     ) -> bool {
3859         let self_ty = self.shallow_resolve(trait_ref.skip_binder().self_ty());
3860         debug!(
3861             "self_type_matches_expected_vid(trait_ref={:?}, self_ty={:?}, expected_vid={:?})",
3862             trait_ref, self_ty, expected_vid
3863         );
3864         match self_ty.kind {
3865             ty::Infer(ty::TyVar(found_vid)) => {
3866                 // FIXME: consider using `sub_root_var` here so we
3867                 // can see through subtyping.
3868                 let found_vid = self.root_var(found_vid);
3869                 debug!("self_type_matches_expected_vid - found_vid={:?}", found_vid);
3870                 expected_vid == found_vid
3871             }
3872             _ => false,
3873         }
3874     }
3875
3876     fn obligations_for_self_ty<'b>(
3877         &'b self,
3878         self_ty: ty::TyVid,
3879     ) -> impl Iterator<Item = (ty::PolyTraitRef<'tcx>, traits::PredicateObligation<'tcx>)>
3880     + Captures<'tcx>
3881     + 'b {
3882         // FIXME: consider using `sub_root_var` here so we
3883         // can see through subtyping.
3884         let ty_var_root = self.root_var(self_ty);
3885         debug!(
3886             "obligations_for_self_ty: self_ty={:?} ty_var_root={:?} pending_obligations={:?}",
3887             self_ty,
3888             ty_var_root,
3889             self.fulfillment_cx.borrow().pending_obligations()
3890         );
3891
3892         self.fulfillment_cx
3893             .borrow()
3894             .pending_obligations()
3895             .into_iter()
3896             .filter_map(move |obligation| {
3897                 match obligation.predicate.skip_binders() {
3898                     ty::PredicateAtom::Projection(data) => {
3899                         Some((ty::Binder::bind(data).to_poly_trait_ref(self.tcx), obligation))
3900                     }
3901                     ty::PredicateAtom::Trait(data, _) => {
3902                         Some((ty::Binder::bind(data).to_poly_trait_ref(), obligation))
3903                     }
3904                     ty::PredicateAtom::Subtype(..) => None,
3905                     ty::PredicateAtom::RegionOutlives(..) => None,
3906                     ty::PredicateAtom::TypeOutlives(..) => None,
3907                     ty::PredicateAtom::WellFormed(..) => None,
3908                     ty::PredicateAtom::ObjectSafe(..) => None,
3909                     ty::PredicateAtom::ConstEvaluatable(..) => None,
3910                     ty::PredicateAtom::ConstEquate(..) => None,
3911                     // N.B., this predicate is created by breaking down a
3912                     // `ClosureType: FnFoo()` predicate, where
3913                     // `ClosureType` represents some `Closure`. It can't
3914                     // possibly be referring to the current closure,
3915                     // because we haven't produced the `Closure` for
3916                     // this closure yet; this is exactly why the other
3917                     // code is looking for a self type of a unresolved
3918                     // inference variable.
3919                     ty::PredicateAtom::ClosureKind(..) => None,
3920                 }
3921             })
3922             .filter(move |(tr, _)| self.self_type_matches_expected_vid(*tr, ty_var_root))
3923     }
3924
3925     fn type_var_is_sized(&self, self_ty: ty::TyVid) -> bool {
3926         self.obligations_for_self_ty(self_ty)
3927             .any(|(tr, _)| Some(tr.def_id()) == self.tcx.lang_items().sized_trait())
3928     }
3929
3930     /// Generic function that factors out common logic from function calls,
3931     /// method calls and overloaded operators.
3932     fn check_argument_types(
3933         &self,
3934         sp: Span,
3935         expr: &'tcx hir::Expr<'tcx>,
3936         fn_inputs: &[Ty<'tcx>],
3937         expected_arg_tys: &[Ty<'tcx>],
3938         args: &'tcx [hir::Expr<'tcx>],
3939         c_variadic: bool,
3940         tuple_arguments: TupleArgumentsFlag,
3941         def_span: Option<Span>,
3942     ) {
3943         let tcx = self.tcx;
3944         // Grab the argument types, supplying fresh type variables
3945         // if the wrong number of arguments were supplied
3946         let supplied_arg_count = if tuple_arguments == DontTupleArguments { args.len() } else { 1 };
3947
3948         // All the input types from the fn signature must outlive the call
3949         // so as to validate implied bounds.
3950         for (&fn_input_ty, arg_expr) in fn_inputs.iter().zip(args.iter()) {
3951             self.register_wf_obligation(fn_input_ty.into(), arg_expr.span, traits::MiscObligation);
3952         }
3953
3954         let expected_arg_count = fn_inputs.len();
3955
3956         let param_count_error = |expected_count: usize,
3957                                  arg_count: usize,
3958                                  error_code: &str,
3959                                  c_variadic: bool,
3960                                  sugg_unit: bool| {
3961             let (span, start_span, args) = match &expr.kind {
3962                 hir::ExprKind::Call(hir::Expr { span, .. }, args) => (*span, *span, &args[..]),
3963                 hir::ExprKind::MethodCall(path_segment, span, args, _) => (
3964                     *span,
3965                     // `sp` doesn't point at the whole `foo.bar()`, only at `bar`.
3966                     path_segment
3967                         .args
3968                         .and_then(|args| args.args.iter().last())
3969                         // Account for `foo.bar::<T>()`.
3970                         .map(|arg| {
3971                             // Skip the closing `>`.
3972                             tcx.sess
3973                                 .source_map()
3974                                 .next_point(tcx.sess.source_map().next_point(arg.span()))
3975                         })
3976                         .unwrap_or(*span),
3977                     &args[1..], // Skip the receiver.
3978                 ),
3979                 k => span_bug!(sp, "checking argument types on a non-call: `{:?}`", k),
3980             };
3981             let arg_spans = if args.is_empty() {
3982                 // foo()
3983                 // ^^^-- supplied 0 arguments
3984                 // |
3985                 // expected 2 arguments
3986                 vec![tcx.sess.source_map().next_point(start_span).with_hi(sp.hi())]
3987             } else {
3988                 // foo(1, 2, 3)
3989                 // ^^^ -  -  - supplied 3 arguments
3990                 // |
3991                 // expected 2 arguments
3992                 args.iter().map(|arg| arg.span).collect::<Vec<Span>>()
3993             };
3994
3995             let mut err = tcx.sess.struct_span_err_with_code(
3996                 span,
3997                 &format!(
3998                     "this function takes {}{} but {} {} supplied",
3999                     if c_variadic { "at least " } else { "" },
4000                     potentially_plural_count(expected_count, "argument"),
4001                     potentially_plural_count(arg_count, "argument"),
4002                     if arg_count == 1 { "was" } else { "were" }
4003                 ),
4004                 DiagnosticId::Error(error_code.to_owned()),
4005             );
4006             let label = format!("supplied {}", potentially_plural_count(arg_count, "argument"));
4007             for (i, span) in arg_spans.into_iter().enumerate() {
4008                 err.span_label(
4009                     span,
4010                     if arg_count == 0 || i + 1 == arg_count { &label } else { "" },
4011                 );
4012             }
4013
4014             if let Some(def_s) = def_span.map(|sp| tcx.sess.source_map().guess_head_span(sp)) {
4015                 err.span_label(def_s, "defined here");
4016             }
4017             if sugg_unit {
4018                 let sugg_span = tcx.sess.source_map().end_point(expr.span);
4019                 // remove closing `)` from the span
4020                 let sugg_span = sugg_span.shrink_to_lo();
4021                 err.span_suggestion(
4022                     sugg_span,
4023                     "expected the unit value `()`; create it with empty parentheses",
4024                     String::from("()"),
4025                     Applicability::MachineApplicable,
4026                 );
4027             } else {
4028                 err.span_label(
4029                     span,
4030                     format!(
4031                         "expected {}{}",
4032                         if c_variadic { "at least " } else { "" },
4033                         potentially_plural_count(expected_count, "argument")
4034                     ),
4035                 );
4036             }
4037             err.emit();
4038         };
4039
4040         let mut expected_arg_tys = expected_arg_tys.to_vec();
4041
4042         let formal_tys = if tuple_arguments == TupleArguments {
4043             let tuple_type = self.structurally_resolved_type(sp, fn_inputs[0]);
4044             match tuple_type.kind {
4045                 ty::Tuple(arg_types) if arg_types.len() != args.len() => {
4046                     param_count_error(arg_types.len(), args.len(), "E0057", false, false);
4047                     expected_arg_tys = vec![];
4048                     self.err_args(args.len())
4049                 }
4050                 ty::Tuple(arg_types) => {
4051                     expected_arg_tys = match expected_arg_tys.get(0) {
4052                         Some(&ty) => match ty.kind {
4053                             ty::Tuple(ref tys) => tys.iter().map(|k| k.expect_ty()).collect(),
4054                             _ => vec![],
4055                         },
4056                         None => vec![],
4057                     };
4058                     arg_types.iter().map(|k| k.expect_ty()).collect()
4059                 }
4060                 _ => {
4061                     struct_span_err!(
4062                         tcx.sess,
4063                         sp,
4064                         E0059,
4065                         "cannot use call notation; the first type parameter \
4066                          for the function trait is neither a tuple nor unit"
4067                     )
4068                     .emit();
4069                     expected_arg_tys = vec![];
4070                     self.err_args(args.len())
4071                 }
4072             }
4073         } else if expected_arg_count == supplied_arg_count {
4074             fn_inputs.to_vec()
4075         } else if c_variadic {
4076             if supplied_arg_count >= expected_arg_count {
4077                 fn_inputs.to_vec()
4078             } else {
4079                 param_count_error(expected_arg_count, supplied_arg_count, "E0060", true, false);
4080                 expected_arg_tys = vec![];
4081                 self.err_args(supplied_arg_count)
4082             }
4083         } else {
4084             // is the missing argument of type `()`?
4085             let sugg_unit = if expected_arg_tys.len() == 1 && supplied_arg_count == 0 {
4086                 self.resolve_vars_if_possible(&expected_arg_tys[0]).is_unit()
4087             } else if fn_inputs.len() == 1 && supplied_arg_count == 0 {
4088                 self.resolve_vars_if_possible(&fn_inputs[0]).is_unit()
4089             } else {
4090                 false
4091             };
4092             param_count_error(expected_arg_count, supplied_arg_count, "E0061", false, sugg_unit);
4093
4094             expected_arg_tys = vec![];
4095             self.err_args(supplied_arg_count)
4096         };
4097
4098         debug!(
4099             "check_argument_types: formal_tys={:?}",
4100             formal_tys.iter().map(|t| self.ty_to_string(*t)).collect::<Vec<String>>()
4101         );
4102
4103         // If there is no expectation, expect formal_tys.
4104         let expected_arg_tys =
4105             if !expected_arg_tys.is_empty() { expected_arg_tys } else { formal_tys.clone() };
4106
4107         let mut final_arg_types: Vec<(usize, Ty<'_>, Ty<'_>)> = vec![];
4108
4109         // Check the arguments.
4110         // We do this in a pretty awful way: first we type-check any arguments
4111         // that are not closures, then we type-check the closures. This is so
4112         // that we have more information about the types of arguments when we
4113         // type-check the functions. This isn't really the right way to do this.
4114         for &check_closures in &[false, true] {
4115             debug!("check_closures={}", check_closures);
4116
4117             // More awful hacks: before we check argument types, try to do
4118             // an "opportunistic" trait resolution of any trait bounds on
4119             // the call. This helps coercions.
4120             if check_closures {
4121                 self.select_obligations_where_possible(false, |errors| {
4122                     self.point_at_type_arg_instead_of_call_if_possible(errors, expr);
4123                     self.point_at_arg_instead_of_call_if_possible(
4124                         errors,
4125                         &final_arg_types[..],
4126                         sp,
4127                         &args,
4128                     );
4129                 })
4130             }
4131
4132             // For C-variadic functions, we don't have a declared type for all of
4133             // the arguments hence we only do our usual type checking with
4134             // the arguments who's types we do know.
4135             let t = if c_variadic {
4136                 expected_arg_count
4137             } else if tuple_arguments == TupleArguments {
4138                 args.len()
4139             } else {
4140                 supplied_arg_count
4141             };
4142             for (i, arg) in args.iter().take(t).enumerate() {
4143                 // Warn only for the first loop (the "no closures" one).
4144                 // Closure arguments themselves can't be diverging, but
4145                 // a previous argument can, e.g., `foo(panic!(), || {})`.
4146                 if !check_closures {
4147                     self.warn_if_unreachable(arg.hir_id, arg.span, "expression");
4148                 }
4149
4150                 let is_closure = match arg.kind {
4151                     ExprKind::Closure(..) => true,
4152                     _ => false,
4153                 };
4154
4155                 if is_closure != check_closures {
4156                     continue;
4157                 }
4158
4159                 debug!("checking the argument");
4160                 let formal_ty = formal_tys[i];
4161
4162                 // The special-cased logic below has three functions:
4163                 // 1. Provide as good of an expected type as possible.
4164                 let expected = Expectation::rvalue_hint(self, expected_arg_tys[i]);
4165
4166                 let checked_ty = self.check_expr_with_expectation(&arg, expected);
4167
4168                 // 2. Coerce to the most detailed type that could be coerced
4169                 //    to, which is `expected_ty` if `rvalue_hint` returns an
4170                 //    `ExpectHasType(expected_ty)`, or the `formal_ty` otherwise.
4171                 let coerce_ty = expected.only_has_type(self).unwrap_or(formal_ty);
4172                 // We're processing function arguments so we definitely want to use
4173                 // two-phase borrows.
4174                 self.demand_coerce(&arg, checked_ty, coerce_ty, None, AllowTwoPhase::Yes);
4175                 final_arg_types.push((i, checked_ty, coerce_ty));
4176
4177                 // 3. Relate the expected type and the formal one,
4178                 //    if the expected type was used for the coercion.
4179                 self.demand_suptype(arg.span, formal_ty, coerce_ty);
4180             }
4181         }
4182
4183         // We also need to make sure we at least write the ty of the other
4184         // arguments which we skipped above.
4185         if c_variadic {
4186             fn variadic_error<'tcx>(s: &Session, span: Span, t: Ty<'tcx>, cast_ty: &str) {
4187                 use crate::structured_errors::{StructuredDiagnostic, VariadicError};
4188                 VariadicError::new(s, span, t, cast_ty).diagnostic().emit();
4189             }
4190
4191             for arg in args.iter().skip(expected_arg_count) {
4192                 let arg_ty = self.check_expr(&arg);
4193
4194                 // There are a few types which get autopromoted when passed via varargs
4195                 // in C but we just error out instead and require explicit casts.
4196                 let arg_ty = self.structurally_resolved_type(arg.span, arg_ty);
4197                 match arg_ty.kind {
4198                     ty::Float(ast::FloatTy::F32) => {
4199                         variadic_error(tcx.sess, arg.span, arg_ty, "c_double");
4200                     }
4201                     ty::Int(ast::IntTy::I8 | ast::IntTy::I16) | ty::Bool => {
4202                         variadic_error(tcx.sess, arg.span, arg_ty, "c_int");
4203                     }
4204                     ty::Uint(ast::UintTy::U8 | ast::UintTy::U16) => {
4205                         variadic_error(tcx.sess, arg.span, arg_ty, "c_uint");
4206                     }
4207                     ty::FnDef(..) => {
4208                         let ptr_ty = self.tcx.mk_fn_ptr(arg_ty.fn_sig(self.tcx));
4209                         let ptr_ty = self.resolve_vars_if_possible(&ptr_ty);
4210                         variadic_error(tcx.sess, arg.span, arg_ty, &ptr_ty.to_string());
4211                     }
4212                     _ => {}
4213                 }
4214             }
4215         }
4216     }
4217
4218     fn err_args(&self, len: usize) -> Vec<Ty<'tcx>> {
4219         vec![self.tcx.ty_error(); len]
4220     }
4221
4222     /// Given a vec of evaluated `FulfillmentError`s and an `fn` call argument expressions, we walk
4223     /// the checked and coerced types for each argument to see if any of the `FulfillmentError`s
4224     /// reference a type argument. The reason to walk also the checked type is that the coerced type
4225     /// can be not easily comparable with predicate type (because of coercion). If the types match
4226     /// for either checked or coerced type, and there's only *one* argument that does, we point at
4227     /// the corresponding argument's expression span instead of the `fn` call path span.
4228     fn point_at_arg_instead_of_call_if_possible(
4229         &self,
4230         errors: &mut Vec<traits::FulfillmentError<'tcx>>,
4231         final_arg_types: &[(usize, Ty<'tcx>, Ty<'tcx>)],
4232         call_sp: Span,
4233         args: &'tcx [hir::Expr<'tcx>],
4234     ) {
4235         // We *do not* do this for desugared call spans to keep good diagnostics when involving
4236         // the `?` operator.
4237         if call_sp.desugaring_kind().is_some() {
4238             return;
4239         }
4240
4241         for error in errors {
4242             // Only if the cause is somewhere inside the expression we want try to point at arg.
4243             // Otherwise, it means that the cause is somewhere else and we should not change
4244             // anything because we can break the correct span.
4245             if !call_sp.contains(error.obligation.cause.span) {
4246                 continue;
4247             }
4248
4249             if let ty::PredicateAtom::Trait(predicate, _) =
4250                 error.obligation.predicate.skip_binders()
4251             {
4252                 // Collect the argument position for all arguments that could have caused this
4253                 // `FulfillmentError`.
4254                 let mut referenced_in = final_arg_types
4255                     .iter()
4256                     .map(|&(i, checked_ty, _)| (i, checked_ty))
4257                     .chain(final_arg_types.iter().map(|&(i, _, coerced_ty)| (i, coerced_ty)))
4258                     .flat_map(|(i, ty)| {
4259                         let ty = self.resolve_vars_if_possible(&ty);
4260                         // We walk the argument type because the argument's type could have
4261                         // been `Option<T>`, but the `FulfillmentError` references `T`.
4262                         if ty.walk().any(|arg| arg == predicate.self_ty().into()) {
4263                             Some(i)
4264                         } else {
4265                             None
4266                         }
4267                     })
4268                     .collect::<Vec<_>>();
4269
4270                 // Both checked and coerced types could have matched, thus we need to remove
4271                 // duplicates.
4272                 referenced_in.sort();
4273                 referenced_in.dedup();
4274
4275                 if let (Some(ref_in), None) = (referenced_in.pop(), referenced_in.pop()) {
4276                     // We make sure that only *one* argument matches the obligation failure
4277                     // and we assign the obligation's span to its expression's.
4278                     error.obligation.cause.make_mut().span = args[ref_in].span;
4279                     error.points_at_arg_span = true;
4280                 }
4281             }
4282         }
4283     }
4284
4285     /// Given a vec of evaluated `FulfillmentError`s and an `fn` call expression, we walk the
4286     /// `PathSegment`s and resolve their type parameters to see if any of the `FulfillmentError`s
4287     /// were caused by them. If they were, we point at the corresponding type argument's span
4288     /// instead of the `fn` call path span.
4289     fn point_at_type_arg_instead_of_call_if_possible(
4290         &self,
4291         errors: &mut Vec<traits::FulfillmentError<'tcx>>,
4292         call_expr: &'tcx hir::Expr<'tcx>,
4293     ) {
4294         if let hir::ExprKind::Call(path, _) = &call_expr.kind {
4295             if let hir::ExprKind::Path(qpath) = &path.kind {
4296                 if let hir::QPath::Resolved(_, path) = &qpath {
4297                     for error in errors {
4298                         if let ty::PredicateAtom::Trait(predicate, _) =
4299                             error.obligation.predicate.skip_binders()
4300                         {
4301                             // If any of the type arguments in this path segment caused the
4302                             // `FullfillmentError`, point at its span (#61860).
4303                             for arg in path
4304                                 .segments
4305                                 .iter()
4306                                 .filter_map(|seg| seg.args.as_ref())
4307                                 .flat_map(|a| a.args.iter())
4308                             {
4309                                 if let hir::GenericArg::Type(hir_ty) = &arg {
4310                                     if let hir::TyKind::Path(hir::QPath::TypeRelative(..)) =
4311                                         &hir_ty.kind
4312                                     {
4313                                         // Avoid ICE with associated types. As this is best
4314                                         // effort only, it's ok to ignore the case. It
4315                                         // would trigger in `is_send::<T::AssocType>();`
4316                                         // from `typeck-default-trait-impl-assoc-type.rs`.
4317                                     } else {
4318                                         let ty = AstConv::ast_ty_to_ty(self, hir_ty);
4319                                         let ty = self.resolve_vars_if_possible(&ty);
4320                                         if ty == predicate.self_ty() {
4321                                             error.obligation.cause.make_mut().span = hir_ty.span;
4322                                         }
4323                                     }
4324                                 }
4325                             }
4326                         }
4327                     }
4328                 }
4329             }
4330         }
4331     }
4332
4333     // AST fragment checking
4334     fn check_lit(&self, lit: &hir::Lit, expected: Expectation<'tcx>) -> Ty<'tcx> {
4335         let tcx = self.tcx;
4336
4337         match lit.node {
4338             ast::LitKind::Str(..) => tcx.mk_static_str(),
4339             ast::LitKind::ByteStr(ref v) => {
4340                 tcx.mk_imm_ref(tcx.lifetimes.re_static, tcx.mk_array(tcx.types.u8, v.len() as u64))
4341             }
4342             ast::LitKind::Byte(_) => tcx.types.u8,
4343             ast::LitKind::Char(_) => tcx.types.char,
4344             ast::LitKind::Int(_, ast::LitIntType::Signed(t)) => tcx.mk_mach_int(t),
4345             ast::LitKind::Int(_, ast::LitIntType::Unsigned(t)) => tcx.mk_mach_uint(t),
4346             ast::LitKind::Int(_, ast::LitIntType::Unsuffixed) => {
4347                 let opt_ty = expected.to_option(self).and_then(|ty| match ty.kind {
4348                     ty::Int(_) | ty::Uint(_) => Some(ty),
4349                     ty::Char => Some(tcx.types.u8),
4350                     ty::RawPtr(..) => Some(tcx.types.usize),
4351                     ty::FnDef(..) | ty::FnPtr(_) => Some(tcx.types.usize),
4352                     _ => None,
4353                 });
4354                 opt_ty.unwrap_or_else(|| self.next_int_var())
4355             }
4356             ast::LitKind::Float(_, ast::LitFloatType::Suffixed(t)) => tcx.mk_mach_float(t),
4357             ast::LitKind::Float(_, ast::LitFloatType::Unsuffixed) => {
4358                 let opt_ty = expected.to_option(self).and_then(|ty| match ty.kind {
4359                     ty::Float(_) => Some(ty),
4360                     _ => None,
4361                 });
4362                 opt_ty.unwrap_or_else(|| self.next_float_var())
4363             }
4364             ast::LitKind::Bool(_) => tcx.types.bool,
4365             ast::LitKind::Err(_) => tcx.ty_error(),
4366         }
4367     }
4368
4369     /// Unifies the output type with the expected type early, for more coercions
4370     /// and forward type information on the input expressions.
4371     fn expected_inputs_for_expected_output(
4372         &self,
4373         call_span: Span,
4374         expected_ret: Expectation<'tcx>,
4375         formal_ret: Ty<'tcx>,
4376         formal_args: &[Ty<'tcx>],
4377     ) -> Vec<Ty<'tcx>> {
4378         let formal_ret = self.resolve_vars_with_obligations(formal_ret);
4379         let ret_ty = match expected_ret.only_has_type(self) {
4380             Some(ret) => ret,
4381             None => return Vec::new(),
4382         };
4383         let expect_args = self
4384             .fudge_inference_if_ok(|| {
4385                 // Attempt to apply a subtyping relationship between the formal
4386                 // return type (likely containing type variables if the function
4387                 // is polymorphic) and the expected return type.
4388                 // No argument expectations are produced if unification fails.
4389                 let origin = self.misc(call_span);
4390                 let ures = self.at(&origin, self.param_env).sup(ret_ty, &formal_ret);
4391
4392                 // FIXME(#27336) can't use ? here, Try::from_error doesn't default
4393                 // to identity so the resulting type is not constrained.
4394                 match ures {
4395                     Ok(ok) => {
4396                         // Process any obligations locally as much as
4397                         // we can.  We don't care if some things turn
4398                         // out unconstrained or ambiguous, as we're
4399                         // just trying to get hints here.
4400                         self.save_and_restore_in_snapshot_flag(|_| {
4401                             let mut fulfill = TraitEngine::new(self.tcx);
4402                             for obligation in ok.obligations {
4403                                 fulfill.register_predicate_obligation(self, obligation);
4404                             }
4405                             fulfill.select_where_possible(self)
4406                         })
4407                         .map_err(|_| ())?;
4408                     }
4409                     Err(_) => return Err(()),
4410                 }
4411
4412                 // Record all the argument types, with the substitutions
4413                 // produced from the above subtyping unification.
4414                 Ok(formal_args.iter().map(|ty| self.resolve_vars_if_possible(ty)).collect())
4415             })
4416             .unwrap_or_default();
4417         debug!(
4418             "expected_inputs_for_expected_output(formal={:?} -> {:?}, expected={:?} -> {:?})",
4419             formal_args, formal_ret, expect_args, expected_ret
4420         );
4421         expect_args
4422     }
4423
4424     pub fn check_struct_path(
4425         &self,
4426         qpath: &QPath<'_>,
4427         hir_id: hir::HirId,
4428     ) -> Option<(&'tcx ty::VariantDef, Ty<'tcx>)> {
4429         let path_span = match *qpath {
4430             QPath::Resolved(_, ref path) => path.span,
4431             QPath::TypeRelative(ref qself, _) => qself.span,
4432         };
4433         let (def, ty) = self.finish_resolving_struct_path(qpath, path_span, hir_id);
4434         let variant = match def {
4435             Res::Err => {
4436                 self.set_tainted_by_errors();
4437                 return None;
4438             }
4439             Res::Def(DefKind::Variant, _) => match ty.kind {
4440                 ty::Adt(adt, substs) => Some((adt.variant_of_res(def), adt.did, substs)),
4441                 _ => bug!("unexpected type: {:?}", ty),
4442             },
4443             Res::Def(DefKind::Struct | DefKind::Union | DefKind::TyAlias | DefKind::AssocTy, _)
4444             | Res::SelfTy(..) => match ty.kind {
4445                 ty::Adt(adt, substs) if !adt.is_enum() => {
4446                     Some((adt.non_enum_variant(), adt.did, substs))
4447                 }
4448                 _ => None,
4449             },
4450             _ => bug!("unexpected definition: {:?}", def),
4451         };
4452
4453         if let Some((variant, did, substs)) = variant {
4454             debug!("check_struct_path: did={:?} substs={:?}", did, substs);
4455             self.write_user_type_annotation_from_substs(hir_id, did, substs, None);
4456
4457             // Check bounds on type arguments used in the path.
4458             let (bounds, _) = self.instantiate_bounds(path_span, did, substs);
4459             let cause =
4460                 traits::ObligationCause::new(path_span, self.body_id, traits::ItemObligation(did));
4461             self.add_obligations_for_parameters(cause, bounds);
4462
4463             Some((variant, ty))
4464         } else {
4465             struct_span_err!(
4466                 self.tcx.sess,
4467                 path_span,
4468                 E0071,
4469                 "expected struct, variant or union type, found {}",
4470                 ty.sort_string(self.tcx)
4471             )
4472             .span_label(path_span, "not a struct")
4473             .emit();
4474             None
4475         }
4476     }
4477
4478     // Finish resolving a path in a struct expression or pattern `S::A { .. }` if necessary.
4479     // The newly resolved definition is written into `type_dependent_defs`.
4480     fn finish_resolving_struct_path(
4481         &self,
4482         qpath: &QPath<'_>,
4483         path_span: Span,
4484         hir_id: hir::HirId,
4485     ) -> (Res, Ty<'tcx>) {
4486         match *qpath {
4487             QPath::Resolved(ref maybe_qself, ref path) => {
4488                 let self_ty = maybe_qself.as_ref().map(|qself| self.to_ty(qself));
4489                 let ty = AstConv::res_to_ty(self, self_ty, path, true);
4490                 (path.res, ty)
4491             }
4492             QPath::TypeRelative(ref qself, ref segment) => {
4493                 let ty = self.to_ty(qself);
4494
4495                 let res = if let hir::TyKind::Path(QPath::Resolved(_, ref path)) = qself.kind {
4496                     path.res
4497                 } else {
4498                     Res::Err
4499                 };
4500                 let result =
4501                     AstConv::associated_path_to_ty(self, hir_id, path_span, ty, res, segment, true);
4502                 let ty = result.map(|(ty, _, _)| ty).unwrap_or_else(|_| self.tcx().ty_error());
4503                 let result = result.map(|(_, kind, def_id)| (kind, def_id));
4504
4505                 // Write back the new resolution.
4506                 self.write_resolution(hir_id, result);
4507
4508                 (result.map(|(kind, def_id)| Res::Def(kind, def_id)).unwrap_or(Res::Err), ty)
4509             }
4510         }
4511     }
4512
4513     /// Resolves an associated value path into a base type and associated constant, or method
4514     /// resolution. The newly resolved definition is written into `type_dependent_defs`.
4515     pub fn resolve_ty_and_res_ufcs<'b>(
4516         &self,
4517         qpath: &'b QPath<'b>,
4518         hir_id: hir::HirId,
4519         span: Span,
4520     ) -> (Res, Option<Ty<'tcx>>, &'b [hir::PathSegment<'b>]) {
4521         debug!("resolve_ty_and_res_ufcs: qpath={:?} hir_id={:?} span={:?}", qpath, hir_id, span);
4522         let (ty, qself, item_segment) = match *qpath {
4523             QPath::Resolved(ref opt_qself, ref path) => {
4524                 return (
4525                     path.res,
4526                     opt_qself.as_ref().map(|qself| self.to_ty(qself)),
4527                     &path.segments[..],
4528                 );
4529             }
4530             QPath::TypeRelative(ref qself, ref segment) => (self.to_ty(qself), qself, segment),
4531         };
4532         if let Some(&cached_result) = self.typeck_results.borrow().type_dependent_defs().get(hir_id)
4533         {
4534             // Return directly on cache hit. This is useful to avoid doubly reporting
4535             // errors with default match binding modes. See #44614.
4536             let def =
4537                 cached_result.map(|(kind, def_id)| Res::Def(kind, def_id)).unwrap_or(Res::Err);
4538             return (def, Some(ty), slice::from_ref(&**item_segment));
4539         }
4540         let item_name = item_segment.ident;
4541         let result = self.resolve_ufcs(span, item_name, ty, hir_id).or_else(|error| {
4542             let result = match error {
4543                 method::MethodError::PrivateMatch(kind, def_id, _) => Ok((kind, def_id)),
4544                 _ => Err(ErrorReported),
4545             };
4546             if item_name.name != kw::Invalid {
4547                 if let Some(mut e) = self.report_method_error(
4548                     span,
4549                     ty,
4550                     item_name,
4551                     SelfSource::QPath(qself),
4552                     error,
4553                     None,
4554                 ) {
4555                     e.emit();
4556                 }
4557             }
4558             result
4559         });
4560
4561         // Write back the new resolution.
4562         self.write_resolution(hir_id, result);
4563         (
4564             result.map(|(kind, def_id)| Res::Def(kind, def_id)).unwrap_or(Res::Err),
4565             Some(ty),
4566             slice::from_ref(&**item_segment),
4567         )
4568     }
4569
4570     pub fn check_decl_initializer(
4571         &self,
4572         local: &'tcx hir::Local<'tcx>,
4573         init: &'tcx hir::Expr<'tcx>,
4574     ) -> Ty<'tcx> {
4575         // FIXME(tschottdorf): `contains_explicit_ref_binding()` must be removed
4576         // for #42640 (default match binding modes).
4577         //
4578         // See #44848.
4579         let ref_bindings = local.pat.contains_explicit_ref_binding();
4580
4581         let local_ty = self.local_ty(init.span, local.hir_id).revealed_ty;
4582         if let Some(m) = ref_bindings {
4583             // Somewhat subtle: if we have a `ref` binding in the pattern,
4584             // we want to avoid introducing coercions for the RHS. This is
4585             // both because it helps preserve sanity and, in the case of
4586             // ref mut, for soundness (issue #23116). In particular, in
4587             // the latter case, we need to be clear that the type of the
4588             // referent for the reference that results is *equal to* the
4589             // type of the place it is referencing, and not some
4590             // supertype thereof.
4591             let init_ty = self.check_expr_with_needs(init, Needs::maybe_mut_place(m));
4592             self.demand_eqtype(init.span, local_ty, init_ty);
4593             init_ty
4594         } else {
4595             self.check_expr_coercable_to_type(init, local_ty, None)
4596         }
4597     }
4598
4599     /// Type check a `let` statement.
4600     pub fn check_decl_local(&self, local: &'tcx hir::Local<'tcx>) {
4601         // Determine and write the type which we'll check the pattern against.
4602         let ty = self.local_ty(local.span, local.hir_id).decl_ty;
4603         self.write_ty(local.hir_id, ty);
4604
4605         // Type check the initializer.
4606         if let Some(ref init) = local.init {
4607             let init_ty = self.check_decl_initializer(local, &init);
4608             self.overwrite_local_ty_if_err(local, ty, init_ty);
4609         }
4610
4611         // Does the expected pattern type originate from an expression and what is the span?
4612         let (origin_expr, ty_span) = match (local.ty, local.init) {
4613             (Some(ty), _) => (false, Some(ty.span)), // Bias towards the explicit user type.
4614             (_, Some(init)) => (true, Some(init.span)), // No explicit type; so use the scrutinee.
4615             _ => (false, None), // We have `let $pat;`, so the expected type is unconstrained.
4616         };
4617
4618         // Type check the pattern. Override if necessary to avoid knock-on errors.
4619         self.check_pat_top(&local.pat, ty, ty_span, origin_expr);
4620         let pat_ty = self.node_ty(local.pat.hir_id);
4621         self.overwrite_local_ty_if_err(local, ty, pat_ty);
4622     }
4623
4624     fn overwrite_local_ty_if_err(
4625         &self,
4626         local: &'tcx hir::Local<'tcx>,
4627         decl_ty: Ty<'tcx>,
4628         ty: Ty<'tcx>,
4629     ) {
4630         if ty.references_error() {
4631             // Override the types everywhere with `err()` to avoid knock on errors.
4632             self.write_ty(local.hir_id, ty);
4633             self.write_ty(local.pat.hir_id, ty);
4634             let local_ty = LocalTy { decl_ty, revealed_ty: ty };
4635             self.locals.borrow_mut().insert(local.hir_id, local_ty);
4636             self.locals.borrow_mut().insert(local.pat.hir_id, local_ty);
4637         }
4638     }
4639
4640     fn suggest_semicolon_at_end(&self, span: Span, err: &mut DiagnosticBuilder<'_>) {
4641         err.span_suggestion_short(
4642             span.shrink_to_hi(),
4643             "consider using a semicolon here",
4644             ";".to_string(),
4645             Applicability::MachineApplicable,
4646         );
4647     }
4648
4649     pub fn check_stmt(&self, stmt: &'tcx hir::Stmt<'tcx>) {
4650         // Don't do all the complex logic below for `DeclItem`.
4651         match stmt.kind {
4652             hir::StmtKind::Item(..) => return,
4653             hir::StmtKind::Local(..) | hir::StmtKind::Expr(..) | hir::StmtKind::Semi(..) => {}
4654         }
4655
4656         self.warn_if_unreachable(stmt.hir_id, stmt.span, "statement");
4657
4658         // Hide the outer diverging and `has_errors` flags.
4659         let old_diverges = self.diverges.replace(Diverges::Maybe);
4660         let old_has_errors = self.has_errors.replace(false);
4661
4662         match stmt.kind {
4663             hir::StmtKind::Local(ref l) => {
4664                 self.check_decl_local(&l);
4665             }
4666             // Ignore for now.
4667             hir::StmtKind::Item(_) => {}
4668             hir::StmtKind::Expr(ref expr) => {
4669                 // Check with expected type of `()`.
4670                 self.check_expr_has_type_or_error(&expr, self.tcx.mk_unit(), |err| {
4671                     self.suggest_semicolon_at_end(expr.span, err);
4672                 });
4673             }
4674             hir::StmtKind::Semi(ref expr) => {
4675                 self.check_expr(&expr);
4676             }
4677         }
4678
4679         // Combine the diverging and `has_error` flags.
4680         self.diverges.set(self.diverges.get() | old_diverges);
4681         self.has_errors.set(self.has_errors.get() | old_has_errors);
4682     }
4683
4684     pub fn check_block_no_value(&self, blk: &'tcx hir::Block<'tcx>) {
4685         let unit = self.tcx.mk_unit();
4686         let ty = self.check_block_with_expected(blk, ExpectHasType(unit));
4687
4688         // if the block produces a `!` value, that can always be
4689         // (effectively) coerced to unit.
4690         if !ty.is_never() {
4691             self.demand_suptype(blk.span, unit, ty);
4692         }
4693     }
4694
4695     /// If `expr` is a `match` expression that has only one non-`!` arm, use that arm's tail
4696     /// expression's `Span`, otherwise return `expr.span`. This is done to give better errors
4697     /// when given code like the following:
4698     /// ```text
4699     /// if false { return 0i32; } else { 1u32 }
4700     /// //                               ^^^^ point at this instead of the whole `if` expression
4701     /// ```
4702     fn get_expr_coercion_span(&self, expr: &hir::Expr<'_>) -> rustc_span::Span {
4703         if let hir::ExprKind::Match(_, arms, _) = &expr.kind {
4704             let arm_spans: Vec<Span> = arms
4705                 .iter()
4706                 .filter_map(|arm| {
4707                     self.in_progress_typeck_results
4708                         .and_then(|typeck_results| {
4709                             typeck_results.borrow().node_type_opt(arm.body.hir_id)
4710                         })
4711                         .and_then(|arm_ty| {
4712                             if arm_ty.is_never() {
4713                                 None
4714                             } else {
4715                                 Some(match &arm.body.kind {
4716                                     // Point at the tail expression when possible.
4717                                     hir::ExprKind::Block(block, _) => {
4718                                         block.expr.as_ref().map(|e| e.span).unwrap_or(block.span)
4719                                     }
4720                                     _ => arm.body.span,
4721                                 })
4722                             }
4723                         })
4724                 })
4725                 .collect();
4726             if arm_spans.len() == 1 {
4727                 return arm_spans[0];
4728             }
4729         }
4730         expr.span
4731     }
4732
4733     fn check_block_with_expected(
4734         &self,
4735         blk: &'tcx hir::Block<'tcx>,
4736         expected: Expectation<'tcx>,
4737     ) -> Ty<'tcx> {
4738         let prev = {
4739             let mut fcx_ps = self.ps.borrow_mut();
4740             let unsafety_state = fcx_ps.recurse(blk);
4741             replace(&mut *fcx_ps, unsafety_state)
4742         };
4743
4744         // In some cases, blocks have just one exit, but other blocks
4745         // can be targeted by multiple breaks. This can happen both
4746         // with labeled blocks as well as when we desugar
4747         // a `try { ... }` expression.
4748         //
4749         // Example 1:
4750         //
4751         //    'a: { if true { break 'a Err(()); } Ok(()) }
4752         //
4753         // Here we would wind up with two coercions, one from
4754         // `Err(())` and the other from the tail expression
4755         // `Ok(())`. If the tail expression is omitted, that's a
4756         // "forced unit" -- unless the block diverges, in which
4757         // case we can ignore the tail expression (e.g., `'a: {
4758         // break 'a 22; }` would not force the type of the block
4759         // to be `()`).
4760         let tail_expr = blk.expr.as_ref();
4761         let coerce_to_ty = expected.coercion_target_type(self, blk.span);
4762         let coerce = if blk.targeted_by_break {
4763             CoerceMany::new(coerce_to_ty)
4764         } else {
4765             let tail_expr: &[&hir::Expr<'_>] = match tail_expr {
4766                 Some(e) => slice::from_ref(e),
4767                 None => &[],
4768             };
4769             CoerceMany::with_coercion_sites(coerce_to_ty, tail_expr)
4770         };
4771
4772         let prev_diverges = self.diverges.get();
4773         let ctxt = BreakableCtxt { coerce: Some(coerce), may_break: false };
4774
4775         let (ctxt, ()) = self.with_breakable_ctxt(blk.hir_id, ctxt, || {
4776             for s in blk.stmts {
4777                 self.check_stmt(s);
4778             }
4779
4780             // check the tail expression **without** holding the
4781             // `enclosing_breakables` lock below.
4782             let tail_expr_ty = tail_expr.map(|t| self.check_expr_with_expectation(t, expected));
4783
4784             let mut enclosing_breakables = self.enclosing_breakables.borrow_mut();
4785             let ctxt = enclosing_breakables.find_breakable(blk.hir_id);
4786             let coerce = ctxt.coerce.as_mut().unwrap();
4787             if let Some(tail_expr_ty) = tail_expr_ty {
4788                 let tail_expr = tail_expr.unwrap();
4789                 let span = self.get_expr_coercion_span(tail_expr);
4790                 let cause = self.cause(span, ObligationCauseCode::BlockTailExpression(blk.hir_id));
4791                 coerce.coerce(self, &cause, tail_expr, tail_expr_ty);
4792             } else {
4793                 // Subtle: if there is no explicit tail expression,
4794                 // that is typically equivalent to a tail expression
4795                 // of `()` -- except if the block diverges. In that
4796                 // case, there is no value supplied from the tail
4797                 // expression (assuming there are no other breaks,
4798                 // this implies that the type of the block will be
4799                 // `!`).
4800                 //
4801                 // #41425 -- label the implicit `()` as being the
4802                 // "found type" here, rather than the "expected type".
4803                 if !self.diverges.get().is_always() {
4804                     // #50009 -- Do not point at the entire fn block span, point at the return type
4805                     // span, as it is the cause of the requirement, and
4806                     // `consider_hint_about_removing_semicolon` will point at the last expression
4807                     // if it were a relevant part of the error. This improves usability in editors
4808                     // that highlight errors inline.
4809                     let mut sp = blk.span;
4810                     let mut fn_span = None;
4811                     if let Some((decl, ident)) = self.get_parent_fn_decl(blk.hir_id) {
4812                         let ret_sp = decl.output.span();
4813                         if let Some(block_sp) = self.parent_item_span(blk.hir_id) {
4814                             // HACK: on some cases (`ui/liveness/liveness-issue-2163.rs`) the
4815                             // output would otherwise be incorrect and even misleading. Make sure
4816                             // the span we're aiming at correspond to a `fn` body.
4817                             if block_sp == blk.span {
4818                                 sp = ret_sp;
4819                                 fn_span = Some(ident.span);
4820                             }
4821                         }
4822                     }
4823                     coerce.coerce_forced_unit(
4824                         self,
4825                         &self.misc(sp),
4826                         &mut |err| {
4827                             if let Some(expected_ty) = expected.only_has_type(self) {
4828                                 self.consider_hint_about_removing_semicolon(blk, expected_ty, err);
4829                             }
4830                             if let Some(fn_span) = fn_span {
4831                                 err.span_label(
4832                                     fn_span,
4833                                     "implicitly returns `()` as its body has no tail or `return` \
4834                                      expression",
4835                                 );
4836                             }
4837                         },
4838                         false,
4839                     );
4840                 }
4841             }
4842         });
4843
4844         if ctxt.may_break {
4845             // If we can break from the block, then the block's exit is always reachable
4846             // (... as long as the entry is reachable) - regardless of the tail of the block.
4847             self.diverges.set(prev_diverges);
4848         }
4849
4850         let mut ty = ctxt.coerce.unwrap().complete(self);
4851
4852         if self.has_errors.get() || ty.references_error() {
4853             ty = self.tcx.ty_error()
4854         }
4855
4856         self.write_ty(blk.hir_id, ty);
4857
4858         *self.ps.borrow_mut() = prev;
4859         ty
4860     }
4861
4862     fn parent_item_span(&self, id: hir::HirId) -> Option<Span> {
4863         let node = self.tcx.hir().get(self.tcx.hir().get_parent_item(id));
4864         match node {
4865             Node::Item(&hir::Item { kind: hir::ItemKind::Fn(_, _, body_id), .. })
4866             | Node::ImplItem(&hir::ImplItem { kind: hir::ImplItemKind::Fn(_, body_id), .. }) => {
4867                 let body = self.tcx.hir().body(body_id);
4868                 if let ExprKind::Block(block, _) = &body.value.kind {
4869                     return Some(block.span);
4870                 }
4871             }
4872             _ => {}
4873         }
4874         None
4875     }
4876
4877     /// Given a function block's `HirId`, returns its `FnDecl` if it exists, or `None` otherwise.
4878     fn get_parent_fn_decl(&self, blk_id: hir::HirId) -> Option<(&'tcx hir::FnDecl<'tcx>, Ident)> {
4879         let parent = self.tcx.hir().get(self.tcx.hir().get_parent_item(blk_id));
4880         self.get_node_fn_decl(parent).map(|(fn_decl, ident, _)| (fn_decl, ident))
4881     }
4882
4883     /// Given a function `Node`, return its `FnDecl` if it exists, or `None` otherwise.
4884     fn get_node_fn_decl(&self, node: Node<'tcx>) -> Option<(&'tcx hir::FnDecl<'tcx>, Ident, bool)> {
4885         match node {
4886             Node::Item(&hir::Item { ident, kind: hir::ItemKind::Fn(ref sig, ..), .. }) => {
4887                 // This is less than ideal, it will not suggest a return type span on any
4888                 // method called `main`, regardless of whether it is actually the entry point,
4889                 // but it will still present it as the reason for the expected type.
4890                 Some((&sig.decl, ident, ident.name != sym::main))
4891             }
4892             Node::TraitItem(&hir::TraitItem {
4893                 ident,
4894                 kind: hir::TraitItemKind::Fn(ref sig, ..),
4895                 ..
4896             }) => Some((&sig.decl, ident, true)),
4897             Node::ImplItem(&hir::ImplItem {
4898                 ident,
4899                 kind: hir::ImplItemKind::Fn(ref sig, ..),
4900                 ..
4901             }) => Some((&sig.decl, ident, false)),
4902             _ => None,
4903         }
4904     }
4905
4906     /// Given a `HirId`, return the `FnDecl` of the method it is enclosed by and whether a
4907     /// suggestion can be made, `None` otherwise.
4908     pub fn get_fn_decl(&self, blk_id: hir::HirId) -> Option<(&'tcx hir::FnDecl<'tcx>, bool)> {
4909         // Get enclosing Fn, if it is a function or a trait method, unless there's a `loop` or
4910         // `while` before reaching it, as block tail returns are not available in them.
4911         self.tcx.hir().get_return_block(blk_id).and_then(|blk_id| {
4912             let parent = self.tcx.hir().get(blk_id);
4913             self.get_node_fn_decl(parent).map(|(fn_decl, _, is_main)| (fn_decl, is_main))
4914         })
4915     }
4916
4917     /// On implicit return expressions with mismatched types, provides the following suggestions:
4918     ///
4919     /// - Points out the method's return type as the reason for the expected type.
4920     /// - Possible missing semicolon.
4921     /// - Possible missing return type if the return type is the default, and not `fn main()`.
4922     pub fn suggest_mismatched_types_on_tail(
4923         &self,
4924         err: &mut DiagnosticBuilder<'_>,
4925         expr: &'tcx hir::Expr<'tcx>,
4926         expected: Ty<'tcx>,
4927         found: Ty<'tcx>,
4928         cause_span: Span,
4929         blk_id: hir::HirId,
4930     ) -> bool {
4931         let expr = expr.peel_drop_temps();
4932         self.suggest_missing_semicolon(err, expr, expected, cause_span);
4933         let mut pointing_at_return_type = false;
4934         if let Some((fn_decl, can_suggest)) = self.get_fn_decl(blk_id) {
4935             pointing_at_return_type =
4936                 self.suggest_missing_return_type(err, &fn_decl, expected, found, can_suggest);
4937         }
4938         pointing_at_return_type
4939     }
4940
4941     /// When encountering an fn-like ctor that needs to unify with a value, check whether calling
4942     /// the ctor would successfully solve the type mismatch and if so, suggest it:
4943     /// ```
4944     /// fn foo(x: usize) -> usize { x }
4945     /// let x: usize = foo;  // suggest calling the `foo` function: `foo(42)`
4946     /// ```
4947     fn suggest_fn_call(
4948         &self,
4949         err: &mut DiagnosticBuilder<'_>,
4950         expr: &hir::Expr<'_>,
4951         expected: Ty<'tcx>,
4952         found: Ty<'tcx>,
4953     ) -> bool {
4954         let hir = self.tcx.hir();
4955         let (def_id, sig) = match found.kind {
4956             ty::FnDef(def_id, _) => (def_id, found.fn_sig(self.tcx)),
4957             ty::Closure(def_id, substs) => (def_id, substs.as_closure().sig()),
4958             _ => return false,
4959         };
4960
4961         let sig = self.replace_bound_vars_with_fresh_vars(expr.span, infer::FnCall, &sig).0;
4962         let sig = self.normalize_associated_types_in(expr.span, &sig);
4963         if self.can_coerce(sig.output(), expected) {
4964             let (mut sugg_call, applicability) = if sig.inputs().is_empty() {
4965                 (String::new(), Applicability::MachineApplicable)
4966             } else {
4967                 ("...".to_string(), Applicability::HasPlaceholders)
4968             };
4969             let mut msg = "call this function";
4970             match hir.get_if_local(def_id) {
4971                 Some(
4972                     Node::Item(hir::Item { kind: ItemKind::Fn(.., body_id), .. })
4973                     | Node::ImplItem(hir::ImplItem {
4974                         kind: hir::ImplItemKind::Fn(_, body_id), ..
4975                     })
4976                     | Node::TraitItem(hir::TraitItem {
4977                         kind: hir::TraitItemKind::Fn(.., hir::TraitFn::Provided(body_id)),
4978                         ..
4979                     }),
4980                 ) => {
4981                     let body = hir.body(*body_id);
4982                     sugg_call = body
4983                         .params
4984                         .iter()
4985                         .map(|param| match &param.pat.kind {
4986                             hir::PatKind::Binding(_, _, ident, None)
4987                                 if ident.name != kw::SelfLower =>
4988                             {
4989                                 ident.to_string()
4990                             }
4991                             _ => "_".to_string(),
4992                         })
4993                         .collect::<Vec<_>>()
4994                         .join(", ");
4995                 }
4996                 Some(Node::Expr(hir::Expr {
4997                     kind: ExprKind::Closure(_, _, body_id, _, _),
4998                     span: full_closure_span,
4999                     ..
5000                 })) => {
5001                     if *full_closure_span == expr.span {
5002                         return false;
5003                     }
5004                     msg = "call this closure";
5005                     let body = hir.body(*body_id);
5006                     sugg_call = body
5007                         .params
5008                         .iter()
5009                         .map(|param| match &param.pat.kind {
5010                             hir::PatKind::Binding(_, _, ident, None)
5011                                 if ident.name != kw::SelfLower =>
5012                             {
5013                                 ident.to_string()
5014                             }
5015                             _ => "_".to_string(),
5016                         })
5017                         .collect::<Vec<_>>()
5018                         .join(", ");
5019                 }
5020                 Some(Node::Ctor(hir::VariantData::Tuple(fields, _))) => {
5021                     sugg_call = fields.iter().map(|_| "_").collect::<Vec<_>>().join(", ");
5022                     match def_id.as_local().map(|def_id| hir.def_kind(def_id)) {
5023                         Some(DefKind::Ctor(hir::def::CtorOf::Variant, _)) => {
5024                             msg = "instantiate this tuple variant";
5025                         }
5026                         Some(DefKind::Ctor(CtorOf::Struct, _)) => {
5027                             msg = "instantiate this tuple struct";
5028                         }
5029                         _ => {}
5030                     }
5031                 }
5032                 Some(Node::ForeignItem(hir::ForeignItem {
5033                     kind: hir::ForeignItemKind::Fn(_, idents, _),
5034                     ..
5035                 })) => {
5036                     sugg_call = idents
5037                         .iter()
5038                         .map(|ident| {
5039                             if ident.name != kw::SelfLower {
5040                                 ident.to_string()
5041                             } else {
5042                                 "_".to_string()
5043                             }
5044                         })
5045                         .collect::<Vec<_>>()
5046                         .join(", ")
5047                 }
5048                 Some(Node::TraitItem(hir::TraitItem {
5049                     kind: hir::TraitItemKind::Fn(.., hir::TraitFn::Required(idents)),
5050                     ..
5051                 })) => {
5052                     sugg_call = idents
5053                         .iter()
5054                         .map(|ident| {
5055                             if ident.name != kw::SelfLower {
5056                                 ident.to_string()
5057                             } else {
5058                                 "_".to_string()
5059                             }
5060                         })
5061                         .collect::<Vec<_>>()
5062                         .join(", ")
5063                 }
5064                 _ => {}
5065             }
5066             err.span_suggestion_verbose(
5067                 expr.span.shrink_to_hi(),
5068                 &format!("use parentheses to {}", msg),
5069                 format!("({})", sugg_call),
5070                 applicability,
5071             );
5072             return true;
5073         }
5074         false
5075     }
5076
5077     pub fn suggest_deref_ref_or_into(
5078         &self,
5079         err: &mut DiagnosticBuilder<'_>,
5080         expr: &hir::Expr<'_>,
5081         expected: Ty<'tcx>,
5082         found: Ty<'tcx>,
5083         expected_ty_expr: Option<&'tcx hir::Expr<'tcx>>,
5084     ) {
5085         if let Some((sp, msg, suggestion, applicability)) = self.check_ref(expr, found, expected) {
5086             err.span_suggestion(sp, msg, suggestion, applicability);
5087         } else if let (ty::FnDef(def_id, ..), true) =
5088             (&found.kind, self.suggest_fn_call(err, expr, expected, found))
5089         {
5090             if let Some(sp) = self.tcx.hir().span_if_local(*def_id) {
5091                 let sp = self.sess().source_map().guess_head_span(sp);
5092                 err.span_label(sp, &format!("{} defined here", found));
5093             }
5094         } else if !self.check_for_cast(err, expr, found, expected, expected_ty_expr) {
5095             let is_struct_pat_shorthand_field =
5096                 self.is_hir_id_from_struct_pattern_shorthand_field(expr.hir_id, expr.span);
5097             let methods = self.get_conversion_methods(expr.span, expected, found, expr.hir_id);
5098             if let Ok(expr_text) = self.sess().source_map().span_to_snippet(expr.span) {
5099                 let mut suggestions = iter::repeat(&expr_text)
5100                     .zip(methods.iter())
5101                     .filter_map(|(receiver, method)| {
5102                         let method_call = format!(".{}()", method.ident);
5103                         if receiver.ends_with(&method_call) {
5104                             None // do not suggest code that is already there (#53348)
5105                         } else {
5106                             let method_call_list = [".to_vec()", ".to_string()"];
5107                             let sugg = if receiver.ends_with(".clone()")
5108                                 && method_call_list.contains(&method_call.as_str())
5109                             {
5110                                 let max_len = receiver.rfind('.').unwrap();
5111                                 format!("{}{}", &receiver[..max_len], method_call)
5112                             } else {
5113                                 if expr.precedence().order() < ExprPrecedence::MethodCall.order() {
5114                                     format!("({}){}", receiver, method_call)
5115                                 } else {
5116                                     format!("{}{}", receiver, method_call)
5117                                 }
5118                             };
5119                             Some(if is_struct_pat_shorthand_field {
5120                                 format!("{}: {}", receiver, sugg)
5121                             } else {
5122                                 sugg
5123                             })
5124                         }
5125                     })
5126                     .peekable();
5127                 if suggestions.peek().is_some() {
5128                     err.span_suggestions(
5129                         expr.span,
5130                         "try using a conversion method",
5131                         suggestions,
5132                         Applicability::MaybeIncorrect,
5133                     );
5134                 }
5135             }
5136         }
5137     }
5138
5139     /// When encountering the expected boxed value allocated in the stack, suggest allocating it
5140     /// in the heap by calling `Box::new()`.
5141     fn suggest_boxing_when_appropriate(
5142         &self,
5143         err: &mut DiagnosticBuilder<'_>,
5144         expr: &hir::Expr<'_>,
5145         expected: Ty<'tcx>,
5146         found: Ty<'tcx>,
5147     ) {
5148         if self.tcx.hir().is_inside_const_context(expr.hir_id) {
5149             // Do not suggest `Box::new` in const context.
5150             return;
5151         }
5152         if !expected.is_box() || found.is_box() {
5153             return;
5154         }
5155         let boxed_found = self.tcx.mk_box(found);
5156         if let (true, Ok(snippet)) = (
5157             self.can_coerce(boxed_found, expected),
5158             self.sess().source_map().span_to_snippet(expr.span),
5159         ) {
5160             err.span_suggestion(
5161                 expr.span,
5162                 "store this in the heap by calling `Box::new`",
5163                 format!("Box::new({})", snippet),
5164                 Applicability::MachineApplicable,
5165             );
5166             err.note(
5167                 "for more on the distinction between the stack and the heap, read \
5168                  https://doc.rust-lang.org/book/ch15-01-box.html, \
5169                  https://doc.rust-lang.org/rust-by-example/std/box.html, and \
5170                  https://doc.rust-lang.org/std/boxed/index.html",
5171             );
5172         }
5173     }
5174
5175     /// When encountering an `impl Future` where `BoxFuture` is expected, suggest `Box::pin`.
5176     fn suggest_calling_boxed_future_when_appropriate(
5177         &self,
5178         err: &mut DiagnosticBuilder<'_>,
5179         expr: &hir::Expr<'_>,
5180         expected: Ty<'tcx>,
5181         found: Ty<'tcx>,
5182     ) -> bool {
5183         // Handle #68197.
5184
5185         if self.tcx.hir().is_inside_const_context(expr.hir_id) {
5186             // Do not suggest `Box::new` in const context.
5187             return false;
5188         }
5189         let pin_did = self.tcx.lang_items().pin_type();
5190         match expected.kind {
5191             ty::Adt(def, _) if Some(def.did) != pin_did => return false,
5192             // This guards the `unwrap` and `mk_box` below.
5193             _ if pin_did.is_none() || self.tcx.lang_items().owned_box().is_none() => return false,
5194             _ => {}
5195         }
5196         let boxed_found = self.tcx.mk_box(found);
5197         let new_found = self.tcx.mk_lang_item(boxed_found, PinTypeLangItem).unwrap();
5198         if let (true, Ok(snippet)) = (
5199             self.can_coerce(new_found, expected),
5200             self.sess().source_map().span_to_snippet(expr.span),
5201         ) {
5202             match found.kind {
5203                 ty::Adt(def, _) if def.is_box() => {
5204                     err.help("use `Box::pin`");
5205                 }
5206                 _ => {
5207                     err.span_suggestion(
5208                         expr.span,
5209                         "you need to pin and box this expression",
5210                         format!("Box::pin({})", snippet),
5211                         Applicability::MachineApplicable,
5212                     );
5213                 }
5214             }
5215             true
5216         } else {
5217             false
5218         }
5219     }
5220
5221     /// A common error is to forget to add a semicolon at the end of a block, e.g.,
5222     ///
5223     /// ```
5224     /// fn foo() {
5225     ///     bar_that_returns_u32()
5226     /// }
5227     /// ```
5228     ///
5229     /// This routine checks if the return expression in a block would make sense on its own as a
5230     /// statement and the return type has been left as default or has been specified as `()`. If so,
5231     /// it suggests adding a semicolon.
5232     fn suggest_missing_semicolon(
5233         &self,
5234         err: &mut DiagnosticBuilder<'_>,
5235         expression: &'tcx hir::Expr<'tcx>,
5236         expected: Ty<'tcx>,
5237         cause_span: Span,
5238     ) {
5239         if expected.is_unit() {
5240             // `BlockTailExpression` only relevant if the tail expr would be
5241             // useful on its own.
5242             match expression.kind {
5243                 ExprKind::Call(..)
5244                 | ExprKind::MethodCall(..)
5245                 | ExprKind::Loop(..)
5246                 | ExprKind::Match(..)
5247                 | ExprKind::Block(..) => {
5248                     err.span_suggestion(
5249                         cause_span.shrink_to_hi(),
5250                         "try adding a semicolon",
5251                         ";".to_string(),
5252                         Applicability::MachineApplicable,
5253                     );
5254                 }
5255                 _ => (),
5256             }
5257         }
5258     }
5259
5260     /// A possible error is to forget to add a return type that is needed:
5261     ///
5262     /// ```
5263     /// fn foo() {
5264     ///     bar_that_returns_u32()
5265     /// }
5266     /// ```
5267     ///
5268     /// This routine checks if the return type is left as default, the method is not part of an
5269     /// `impl` block and that it isn't the `main` method. If so, it suggests setting the return
5270     /// type.
5271     fn suggest_missing_return_type(
5272         &self,
5273         err: &mut DiagnosticBuilder<'_>,
5274         fn_decl: &hir::FnDecl<'_>,
5275         expected: Ty<'tcx>,
5276         found: Ty<'tcx>,
5277         can_suggest: bool,
5278     ) -> bool {
5279         // Only suggest changing the return type for methods that
5280         // haven't set a return type at all (and aren't `fn main()` or an impl).
5281         match (&fn_decl.output, found.is_suggestable(), can_suggest, expected.is_unit()) {
5282             (&hir::FnRetTy::DefaultReturn(span), true, true, true) => {
5283                 err.span_suggestion(
5284                     span,
5285                     "try adding a return type",
5286                     format!("-> {} ", self.resolve_vars_with_obligations(found)),
5287                     Applicability::MachineApplicable,
5288                 );
5289                 true
5290             }
5291             (&hir::FnRetTy::DefaultReturn(span), false, true, true) => {
5292                 err.span_label(span, "possibly return type missing here?");
5293                 true
5294             }
5295             (&hir::FnRetTy::DefaultReturn(span), _, false, true) => {
5296                 // `fn main()` must return `()`, do not suggest changing return type
5297                 err.span_label(span, "expected `()` because of default return type");
5298                 true
5299             }
5300             // expectation was caused by something else, not the default return
5301             (&hir::FnRetTy::DefaultReturn(_), _, _, false) => false,
5302             (&hir::FnRetTy::Return(ref ty), _, _, _) => {
5303                 // Only point to return type if the expected type is the return type, as if they
5304                 // are not, the expectation must have been caused by something else.
5305                 debug!("suggest_missing_return_type: return type {:?} node {:?}", ty, ty.kind);
5306                 let sp = ty.span;
5307                 let ty = AstConv::ast_ty_to_ty(self, ty);
5308                 debug!("suggest_missing_return_type: return type {:?}", ty);
5309                 debug!("suggest_missing_return_type: expected type {:?}", ty);
5310                 if ty.kind == expected.kind {
5311                     err.span_label(sp, format!("expected `{}` because of return type", expected));
5312                     return true;
5313                 }
5314                 false
5315             }
5316         }
5317     }
5318
5319     /// A possible error is to forget to add `.await` when using futures:
5320     ///
5321     /// ```
5322     /// async fn make_u32() -> u32 {
5323     ///     22
5324     /// }
5325     ///
5326     /// fn take_u32(x: u32) {}
5327     ///
5328     /// async fn foo() {
5329     ///     let x = make_u32();
5330     ///     take_u32(x);
5331     /// }
5332     /// ```
5333     ///
5334     /// This routine checks if the found type `T` implements `Future<Output=U>` where `U` is the
5335     /// expected type. If this is the case, and we are inside of an async body, it suggests adding
5336     /// `.await` to the tail of the expression.
5337     fn suggest_missing_await(
5338         &self,
5339         err: &mut DiagnosticBuilder<'_>,
5340         expr: &hir::Expr<'_>,
5341         expected: Ty<'tcx>,
5342         found: Ty<'tcx>,
5343     ) {
5344         debug!("suggest_missing_await: expr={:?} expected={:?}, found={:?}", expr, expected, found);
5345         // `.await` is not permitted outside of `async` bodies, so don't bother to suggest if the
5346         // body isn't `async`.
5347         let item_id = self.tcx().hir().get_parent_node(self.body_id);
5348         if let Some(body_id) = self.tcx().hir().maybe_body_owned_by(item_id) {
5349             let body = self.tcx().hir().body(body_id);
5350             if let Some(hir::GeneratorKind::Async(_)) = body.generator_kind {
5351                 let sp = expr.span;
5352                 // Check for `Future` implementations by constructing a predicate to
5353                 // prove: `<T as Future>::Output == U`
5354                 let future_trait = self.tcx.require_lang_item(FutureTraitLangItem, Some(sp));
5355                 let item_def_id = self
5356                     .tcx
5357                     .associated_items(future_trait)
5358                     .in_definition_order()
5359                     .next()
5360                     .unwrap()
5361                     .def_id;
5362                 // `<T as Future>::Output`
5363                 let projection_ty = ty::ProjectionTy {
5364                     // `T`
5365                     substs: self
5366                         .tcx
5367                         .mk_substs_trait(found, self.fresh_substs_for_item(sp, item_def_id)),
5368                     // `Future::Output`
5369                     item_def_id,
5370                 };
5371
5372                 let predicate = ty::PredicateAtom::Projection(ty::ProjectionPredicate {
5373                     projection_ty,
5374                     ty: expected,
5375                 })
5376                 .to_predicate(self.tcx)
5377                 .potentially_quantified(self.tcx, ty::PredicateKind::ForAll);
5378                 let obligation = traits::Obligation::new(self.misc(sp), self.param_env, predicate);
5379
5380                 debug!("suggest_missing_await: trying obligation {:?}", obligation);
5381
5382                 if self.infcx.predicate_may_hold(&obligation) {
5383                     debug!("suggest_missing_await: obligation held: {:?}", obligation);
5384                     if let Ok(code) = self.sess().source_map().span_to_snippet(sp) {
5385                         err.span_suggestion(
5386                             sp,
5387                             "consider using `.await` here",
5388                             format!("{}.await", code),
5389                             Applicability::MaybeIncorrect,
5390                         );
5391                     } else {
5392                         debug!("suggest_missing_await: no snippet for {:?}", sp);
5393                     }
5394                 } else {
5395                     debug!("suggest_missing_await: obligation did not hold: {:?}", obligation)
5396                 }
5397             }
5398         }
5399     }
5400
5401     fn note_need_for_fn_pointer(
5402         &self,
5403         err: &mut DiagnosticBuilder<'_>,
5404         expected: Ty<'tcx>,
5405         found: Ty<'tcx>,
5406     ) {
5407         let (sig, did, substs) = match (&expected.kind, &found.kind) {
5408             (ty::FnDef(did1, substs1), ty::FnDef(did2, substs2)) => {
5409                 let sig1 = self.tcx.fn_sig(*did1).subst(self.tcx, substs1);
5410                 let sig2 = self.tcx.fn_sig(*did2).subst(self.tcx, substs2);
5411                 if sig1 != sig2 {
5412                     return;
5413                 }
5414                 err.note(
5415                     "different `fn` items always have unique types, even if their signatures are \
5416                      the same",
5417                 );
5418                 (sig1, *did1, substs1)
5419             }
5420             (ty::FnDef(did, substs), ty::FnPtr(sig2)) => {
5421                 let sig1 = self.tcx.fn_sig(*did).subst(self.tcx, substs);
5422                 if sig1 != *sig2 {
5423                     return;
5424                 }
5425                 (sig1, *did, substs)
5426             }
5427             _ => return,
5428         };
5429         err.help(&format!("change the expected type to be function pointer `{}`", sig));
5430         err.help(&format!(
5431             "if the expected type is due to type inference, cast the expected `fn` to a function \
5432              pointer: `{} as {}`",
5433             self.tcx.def_path_str_with_substs(did, substs),
5434             sig
5435         ));
5436     }
5437
5438     /// A common error is to add an extra semicolon:
5439     ///
5440     /// ```
5441     /// fn foo() -> usize {
5442     ///     22;
5443     /// }
5444     /// ```
5445     ///
5446     /// This routine checks if the final statement in a block is an
5447     /// expression with an explicit semicolon whose type is compatible
5448     /// with `expected_ty`. If so, it suggests removing the semicolon.
5449     fn consider_hint_about_removing_semicolon(
5450         &self,
5451         blk: &'tcx hir::Block<'tcx>,
5452         expected_ty: Ty<'tcx>,
5453         err: &mut DiagnosticBuilder<'_>,
5454     ) {
5455         if let Some(span_semi) = self.could_remove_semicolon(blk, expected_ty) {
5456             err.span_suggestion(
5457                 span_semi,
5458                 "consider removing this semicolon",
5459                 String::new(),
5460                 Applicability::MachineApplicable,
5461             );
5462         }
5463     }
5464
5465     fn could_remove_semicolon(
5466         &self,
5467         blk: &'tcx hir::Block<'tcx>,
5468         expected_ty: Ty<'tcx>,
5469     ) -> Option<Span> {
5470         // Be helpful when the user wrote `{... expr;}` and
5471         // taking the `;` off is enough to fix the error.
5472         let last_stmt = blk.stmts.last()?;
5473         let last_expr = match last_stmt.kind {
5474             hir::StmtKind::Semi(ref e) => e,
5475             _ => return None,
5476         };
5477         let last_expr_ty = self.node_ty(last_expr.hir_id);
5478         if matches!(last_expr_ty.kind, ty::Error(_))
5479             || self.can_sub(self.param_env, last_expr_ty, expected_ty).is_err()
5480         {
5481             return None;
5482         }
5483         let original_span = original_sp(last_stmt.span, blk.span);
5484         Some(original_span.with_lo(original_span.hi() - BytePos(1)))
5485     }
5486
5487     // Instantiates the given path, which must refer to an item with the given
5488     // number of type parameters and type.
5489     pub fn instantiate_value_path(
5490         &self,
5491         segments: &[hir::PathSegment<'_>],
5492         self_ty: Option<Ty<'tcx>>,
5493         res: Res,
5494         span: Span,
5495         hir_id: hir::HirId,
5496     ) -> (Ty<'tcx>, Res) {
5497         debug!(
5498             "instantiate_value_path(segments={:?}, self_ty={:?}, res={:?}, hir_id={})",
5499             segments, self_ty, res, hir_id,
5500         );
5501
5502         let tcx = self.tcx;
5503
5504         let path_segs = match res {
5505             Res::Local(_) | Res::SelfCtor(_) => vec![],
5506             Res::Def(kind, def_id) => {
5507                 AstConv::def_ids_for_value_path_segments(self, segments, self_ty, kind, def_id)
5508             }
5509             _ => bug!("instantiate_value_path on {:?}", res),
5510         };
5511
5512         let mut user_self_ty = None;
5513         let mut is_alias_variant_ctor = false;
5514         match res {
5515             Res::Def(DefKind::Ctor(CtorOf::Variant, _), _) => {
5516                 if let Some(self_ty) = self_ty {
5517                     let adt_def = self_ty.ty_adt_def().unwrap();
5518                     user_self_ty = Some(UserSelfTy { impl_def_id: adt_def.did, self_ty });
5519                     is_alias_variant_ctor = true;
5520                 }
5521             }
5522             Res::Def(DefKind::AssocFn | DefKind::AssocConst, def_id) => {
5523                 let container = tcx.associated_item(def_id).container;
5524                 debug!("instantiate_value_path: def_id={:?} container={:?}", def_id, container);
5525                 match container {
5526                     ty::TraitContainer(trait_did) => {
5527                         callee::check_legal_trait_for_method_call(tcx, span, None, trait_did)
5528                     }
5529                     ty::ImplContainer(impl_def_id) => {
5530                         if segments.len() == 1 {
5531                             // `<T>::assoc` will end up here, and so
5532                             // can `T::assoc`. It this came from an
5533                             // inherent impl, we need to record the
5534                             // `T` for posterity (see `UserSelfTy` for
5535                             // details).
5536                             let self_ty = self_ty.expect("UFCS sugared assoc missing Self");
5537                             user_self_ty = Some(UserSelfTy { impl_def_id, self_ty });
5538                         }
5539                     }
5540                 }
5541             }
5542             _ => {}
5543         }
5544
5545         // Now that we have categorized what space the parameters for each
5546         // segment belong to, let's sort out the parameters that the user
5547         // provided (if any) into their appropriate spaces. We'll also report
5548         // errors if type parameters are provided in an inappropriate place.
5549
5550         let generic_segs: FxHashSet<_> = path_segs.iter().map(|PathSeg(_, index)| index).collect();
5551         let generics_has_err = AstConv::prohibit_generics(
5552             self,
5553             segments.iter().enumerate().filter_map(|(index, seg)| {
5554                 if !generic_segs.contains(&index) || is_alias_variant_ctor {
5555                     Some(seg)
5556                 } else {
5557                     None
5558                 }
5559             }),
5560         );
5561
5562         if let Res::Local(hid) = res {
5563             let ty = self.local_ty(span, hid).decl_ty;
5564             let ty = self.normalize_associated_types_in(span, &ty);
5565             self.write_ty(hir_id, ty);
5566             return (ty, res);
5567         }
5568
5569         if generics_has_err {
5570             // Don't try to infer type parameters when prohibited generic arguments were given.
5571             user_self_ty = None;
5572         }
5573
5574         // Now we have to compare the types that the user *actually*
5575         // provided against the types that were *expected*. If the user
5576         // did not provide any types, then we want to substitute inference
5577         // variables. If the user provided some types, we may still need
5578         // to add defaults. If the user provided *too many* types, that's
5579         // a problem.
5580
5581         let mut infer_args_for_err = FxHashSet::default();
5582         for &PathSeg(def_id, index) in &path_segs {
5583             let seg = &segments[index];
5584             let generics = tcx.generics_of(def_id);
5585             // Argument-position `impl Trait` is treated as a normal generic
5586             // parameter internally, but we don't allow users to specify the
5587             // parameter's value explicitly, so we have to do some error-
5588             // checking here.
5589             if let GenericArgCountResult {
5590                 correct: Err(GenericArgCountMismatch { reported: Some(ErrorReported), .. }),
5591                 ..
5592             } = AstConv::check_generic_arg_count_for_call(
5593                 tcx, span, &generics, &seg, false, // `is_method_call`
5594             ) {
5595                 infer_args_for_err.insert(index);
5596                 self.set_tainted_by_errors(); // See issue #53251.
5597             }
5598         }
5599
5600         let has_self = path_segs
5601             .last()
5602             .map(|PathSeg(def_id, _)| tcx.generics_of(*def_id).has_self)
5603             .unwrap_or(false);
5604
5605         let (res, self_ctor_substs) = if let Res::SelfCtor(impl_def_id) = res {
5606             let ty = self.normalize_ty(span, tcx.at(span).type_of(impl_def_id));
5607             match ty.kind {
5608                 ty::Adt(adt_def, substs) if adt_def.has_ctor() => {
5609                     let variant = adt_def.non_enum_variant();
5610                     let ctor_def_id = variant.ctor_def_id.unwrap();
5611                     (
5612                         Res::Def(DefKind::Ctor(CtorOf::Struct, variant.ctor_kind), ctor_def_id),
5613                         Some(substs),
5614                     )
5615                 }
5616                 _ => {
5617                     let mut err = tcx.sess.struct_span_err(
5618                         span,
5619                         "the `Self` constructor can only be used with tuple or unit structs",
5620                     );
5621                     if let Some(adt_def) = ty.ty_adt_def() {
5622                         match adt_def.adt_kind() {
5623                             AdtKind::Enum => {
5624                                 err.help("did you mean to use one of the enum's variants?");
5625                             }
5626                             AdtKind::Struct | AdtKind::Union => {
5627                                 err.span_suggestion(
5628                                     span,
5629                                     "use curly brackets",
5630                                     String::from("Self { /* fields */ }"),
5631                                     Applicability::HasPlaceholders,
5632                                 );
5633                             }
5634                         }
5635                     }
5636                     err.emit();
5637
5638                     return (tcx.ty_error(), res);
5639                 }
5640             }
5641         } else {
5642             (res, None)
5643         };
5644         let def_id = res.def_id();
5645
5646         // The things we are substituting into the type should not contain
5647         // escaping late-bound regions, and nor should the base type scheme.
5648         let ty = tcx.type_of(def_id);
5649
5650         let arg_count = GenericArgCountResult {
5651             explicit_late_bound: ExplicitLateBound::No,
5652             correct: if infer_args_for_err.is_empty() {
5653                 Ok(())
5654             } else {
5655                 Err(GenericArgCountMismatch::default())
5656             },
5657         };
5658
5659         let substs = self_ctor_substs.unwrap_or_else(|| {
5660             AstConv::create_substs_for_generic_args(
5661                 tcx,
5662                 def_id,
5663                 &[][..],
5664                 has_self,
5665                 self_ty,
5666                 arg_count,
5667                 // Provide the generic args, and whether types should be inferred.
5668                 |def_id| {
5669                     if let Some(&PathSeg(_, index)) =
5670                         path_segs.iter().find(|&PathSeg(did, _)| *did == def_id)
5671                     {
5672                         // If we've encountered an `impl Trait`-related error, we're just
5673                         // going to infer the arguments for better error messages.
5674                         if !infer_args_for_err.contains(&index) {
5675                             // Check whether the user has provided generic arguments.
5676                             if let Some(ref data) = segments[index].args {
5677                                 return (Some(data), segments[index].infer_args);
5678                             }
5679                         }
5680                         return (None, segments[index].infer_args);
5681                     }
5682
5683                     (None, true)
5684                 },
5685                 // Provide substitutions for parameters for which (valid) arguments have been provided.
5686                 |param, arg| match (&param.kind, arg) {
5687                     (GenericParamDefKind::Lifetime, GenericArg::Lifetime(lt)) => {
5688                         AstConv::ast_region_to_region(self, lt, Some(param)).into()
5689                     }
5690                     (GenericParamDefKind::Type { .. }, GenericArg::Type(ty)) => {
5691                         self.to_ty(ty).into()
5692                     }
5693                     (GenericParamDefKind::Const, GenericArg::Const(ct)) => {
5694                         self.const_arg_to_const(&ct.value, param.def_id).into()
5695                     }
5696                     _ => unreachable!(),
5697                 },
5698                 // Provide substitutions for parameters for which arguments are inferred.
5699                 |substs, param, infer_args| {
5700                     match param.kind {
5701                         GenericParamDefKind::Lifetime => {
5702                             self.re_infer(Some(param), span).unwrap().into()
5703                         }
5704                         GenericParamDefKind::Type { has_default, .. } => {
5705                             if !infer_args && has_default {
5706                                 // If we have a default, then we it doesn't matter that we're not
5707                                 // inferring the type arguments: we provide the default where any
5708                                 // is missing.
5709                                 let default = tcx.type_of(param.def_id);
5710                                 self.normalize_ty(
5711                                     span,
5712                                     default.subst_spanned(tcx, substs.unwrap(), Some(span)),
5713                                 )
5714                                 .into()
5715                             } else {
5716                                 // If no type arguments were provided, we have to infer them.
5717                                 // This case also occurs as a result of some malformed input, e.g.
5718                                 // a lifetime argument being given instead of a type parameter.
5719                                 // Using inference instead of `Error` gives better error messages.
5720                                 self.var_for_def(span, param)
5721                             }
5722                         }
5723                         GenericParamDefKind::Const => {
5724                             // FIXME(const_generics:defaults)
5725                             // No const parameters were provided, we have to infer them.
5726                             self.var_for_def(span, param)
5727                         }
5728                     }
5729                 },
5730             )
5731         });
5732         assert!(!substs.has_escaping_bound_vars());
5733         assert!(!ty.has_escaping_bound_vars());
5734
5735         // First, store the "user substs" for later.
5736         self.write_user_type_annotation_from_substs(hir_id, def_id, substs, user_self_ty);
5737
5738         self.add_required_obligations(span, def_id, &substs);
5739
5740         // Substitute the values for the type parameters into the type of
5741         // the referenced item.
5742         let ty_substituted = self.instantiate_type_scheme(span, &substs, &ty);
5743
5744         if let Some(UserSelfTy { impl_def_id, self_ty }) = user_self_ty {
5745             // In the case of `Foo<T>::method` and `<Foo<T>>::method`, if `method`
5746             // is inherent, there is no `Self` parameter; instead, the impl needs
5747             // type parameters, which we can infer by unifying the provided `Self`
5748             // with the substituted impl type.
5749             // This also occurs for an enum variant on a type alias.
5750             let ty = tcx.type_of(impl_def_id);
5751
5752             let impl_ty = self.instantiate_type_scheme(span, &substs, &ty);
5753             match self.at(&self.misc(span), self.param_env).sup(impl_ty, self_ty) {
5754                 Ok(ok) => self.register_infer_ok_obligations(ok),
5755                 Err(_) => {
5756                     self.tcx.sess.delay_span_bug(
5757                         span,
5758                         &format!(
5759                         "instantiate_value_path: (UFCS) {:?} was a subtype of {:?} but now is not?",
5760                         self_ty,
5761                         impl_ty,
5762                     ),
5763                     );
5764                 }
5765             }
5766         }
5767
5768         self.check_rustc_args_require_const(def_id, hir_id, span);
5769
5770         debug!("instantiate_value_path: type of {:?} is {:?}", hir_id, ty_substituted);
5771         self.write_substs(hir_id, substs);
5772
5773         (ty_substituted, res)
5774     }
5775
5776     /// Add all the obligations that are required, substituting and normalized appropriately.
5777     fn add_required_obligations(&self, span: Span, def_id: DefId, substs: &SubstsRef<'tcx>) {
5778         let (bounds, spans) = self.instantiate_bounds(span, def_id, &substs);
5779
5780         for (i, mut obligation) in traits::predicates_for_generics(
5781             traits::ObligationCause::new(span, self.body_id, traits::ItemObligation(def_id)),
5782             self.param_env,
5783             bounds,
5784         )
5785         .enumerate()
5786         {
5787             // This makes the error point at the bound, but we want to point at the argument
5788             if let Some(span) = spans.get(i) {
5789                 obligation.cause.make_mut().code = traits::BindingObligation(def_id, *span);
5790             }
5791             self.register_predicate(obligation);
5792         }
5793     }
5794
5795     fn check_rustc_args_require_const(&self, def_id: DefId, hir_id: hir::HirId, span: Span) {
5796         // We're only interested in functions tagged with
5797         // #[rustc_args_required_const], so ignore anything that's not.
5798         if !self.tcx.has_attr(def_id, sym::rustc_args_required_const) {
5799             return;
5800         }
5801
5802         // If our calling expression is indeed the function itself, we're good!
5803         // If not, generate an error that this can only be called directly.
5804         if let Node::Expr(expr) = self.tcx.hir().get(self.tcx.hir().get_parent_node(hir_id)) {
5805             if let ExprKind::Call(ref callee, ..) = expr.kind {
5806                 if callee.hir_id == hir_id {
5807                     return;
5808                 }
5809             }
5810         }
5811
5812         self.tcx.sess.span_err(
5813             span,
5814             "this function can only be invoked directly, not through a function pointer",
5815         );
5816     }
5817
5818     /// Resolves `typ` by a single level if `typ` is a type variable.
5819     /// If no resolution is possible, then an error is reported.
5820     /// Numeric inference variables may be left unresolved.
5821     pub fn structurally_resolved_type(&self, sp: Span, ty: Ty<'tcx>) -> Ty<'tcx> {
5822         let ty = self.resolve_vars_with_obligations(ty);
5823         if !ty.is_ty_var() {
5824             ty
5825         } else {
5826             if !self.is_tainted_by_errors() {
5827                 self.need_type_info_err((**self).body_id, sp, ty, E0282)
5828                     .note("type must be known at this point")
5829                     .emit();
5830             }
5831             let err = self.tcx.ty_error();
5832             self.demand_suptype(sp, err, ty);
5833             err
5834         }
5835     }
5836
5837     fn with_breakable_ctxt<F: FnOnce() -> R, R>(
5838         &self,
5839         id: hir::HirId,
5840         ctxt: BreakableCtxt<'tcx>,
5841         f: F,
5842     ) -> (BreakableCtxt<'tcx>, R) {
5843         let index;
5844         {
5845             let mut enclosing_breakables = self.enclosing_breakables.borrow_mut();
5846             index = enclosing_breakables.stack.len();
5847             enclosing_breakables.by_id.insert(id, index);
5848             enclosing_breakables.stack.push(ctxt);
5849         }
5850         let result = f();
5851         let ctxt = {
5852             let mut enclosing_breakables = self.enclosing_breakables.borrow_mut();
5853             debug_assert!(enclosing_breakables.stack.len() == index + 1);
5854             enclosing_breakables.by_id.remove(&id).expect("missing breakable context");
5855             enclosing_breakables.stack.pop().expect("missing breakable context")
5856         };
5857         (ctxt, result)
5858     }
5859
5860     /// Instantiate a QueryResponse in a probe context, without a
5861     /// good ObligationCause.
5862     fn probe_instantiate_query_response(
5863         &self,
5864         span: Span,
5865         original_values: &OriginalQueryValues<'tcx>,
5866         query_result: &Canonical<'tcx, QueryResponse<'tcx, Ty<'tcx>>>,
5867     ) -> InferResult<'tcx, Ty<'tcx>> {
5868         self.instantiate_query_response_and_region_obligations(
5869             &traits::ObligationCause::misc(span, self.body_id),
5870             self.param_env,
5871             original_values,
5872             query_result,
5873         )
5874     }
5875
5876     /// Returns `true` if an expression is contained inside the LHS of an assignment expression.
5877     fn expr_in_place(&self, mut expr_id: hir::HirId) -> bool {
5878         let mut contained_in_place = false;
5879
5880         while let hir::Node::Expr(parent_expr) =
5881             self.tcx.hir().get(self.tcx.hir().get_parent_node(expr_id))
5882         {
5883             match &parent_expr.kind {
5884                 hir::ExprKind::Assign(lhs, ..) | hir::ExprKind::AssignOp(_, lhs, ..) => {
5885                     if lhs.hir_id == expr_id {
5886                         contained_in_place = true;
5887                         break;
5888                     }
5889                 }
5890                 _ => (),
5891             }
5892             expr_id = parent_expr.hir_id;
5893         }
5894
5895         contained_in_place
5896     }
5897 }
5898
5899 fn check_type_params_are_used<'tcx>(tcx: TyCtxt<'tcx>, generics: &ty::Generics, ty: Ty<'tcx>) {
5900     debug!("check_type_params_are_used(generics={:?}, ty={:?})", generics, ty);
5901
5902     assert_eq!(generics.parent, None);
5903
5904     if generics.own_counts().types == 0 {
5905         return;
5906     }
5907
5908     let mut params_used = BitSet::new_empty(generics.params.len());
5909
5910     if ty.references_error() {
5911         // If there is already another error, do not emit
5912         // an error for not using a type parameter.
5913         assert!(tcx.sess.has_errors());
5914         return;
5915     }
5916
5917     for leaf in ty.walk() {
5918         if let GenericArgKind::Type(leaf_ty) = leaf.unpack() {
5919             if let ty::Param(param) = leaf_ty.kind {
5920                 debug!("found use of ty param {:?}", param);
5921                 params_used.insert(param.index);
5922             }
5923         }
5924     }
5925
5926     for param in &generics.params {
5927         if !params_used.contains(param.index) {
5928             if let ty::GenericParamDefKind::Type { .. } = param.kind {
5929                 let span = tcx.def_span(param.def_id);
5930                 struct_span_err!(
5931                     tcx.sess,
5932                     span,
5933                     E0091,
5934                     "type parameter `{}` is unused",
5935                     param.name,
5936                 )
5937                 .span_label(span, "unused type parameter")
5938                 .emit();
5939             }
5940         }
5941     }
5942 }
5943
5944 fn fatally_break_rust(sess: &Session) {
5945     let handler = sess.diagnostic();
5946     handler.span_bug_no_panic(
5947         MultiSpan::new(),
5948         "It looks like you're trying to break rust; would you like some ICE?",
5949     );
5950     handler.note_without_error("the compiler expectedly panicked. this is a feature.");
5951     handler.note_without_error(
5952         "we would appreciate a joke overview: \
5953          https://github.com/rust-lang/rust/issues/43162#issuecomment-320764675",
5954     );
5955     handler.note_without_error(&format!(
5956         "rustc {} running on {}",
5957         option_env!("CFG_VERSION").unwrap_or("unknown_version"),
5958         config::host_triple(),
5959     ));
5960 }
5961
5962 fn potentially_plural_count(count: usize, word: &str) -> String {
5963     format!("{} {}{}", count, word, pluralize!(count))
5964 }