1 use crate::coercion::CoerceMany;
2 use crate::gather_locals::GatherLocalsVisitor;
3 use crate::{FnCtxt, Inherited};
4 use crate::{GeneratorTypes, UnsafetyState};
6 use rustc_hir::def::DefKind;
7 use rustc_hir::intravisit::Visitor;
8 use rustc_hir::lang_items::LangItem;
9 use rustc_hir_analysis::check::fn_maybe_err;
10 use rustc_infer::infer::type_variable::{TypeVariableOrigin, TypeVariableOriginKind};
11 use rustc_infer::infer::RegionVariableOrigin;
12 use rustc_middle::ty::{self, Ty, TyCtxt};
13 use rustc_span::def_id::LocalDefId;
14 use rustc_trait_selection::traits;
15 use std::cell::RefCell;
17 /// Helper used for fns and closures. Does the grungy work of checking a function
18 /// body and returns the function context used for that purpose, since in the case of a fn item
19 /// there is still a bit more to do.
22 /// * inherited: other fields inherited from the enclosing fn (if any)
23 #[instrument(skip(inherited, body), level = "debug")]
24 pub(super) fn check_fn<'a, 'tcx>(
25 inherited: &'a Inherited<'tcx>,
26 param_env: ty::ParamEnv<'tcx>,
27 fn_sig: ty::FnSig<'tcx>,
28 decl: &'tcx hir::FnDecl<'tcx>,
30 body: &'tcx hir::Body<'tcx>,
31 can_be_generator: Option<hir::Movability>,
32 ) -> (FnCtxt<'a, 'tcx>, Option<GeneratorTypes<'tcx>>) {
33 // Create the function context. This is either derived from scratch or,
34 // in the case of closures, based on the outer context.
35 let mut fcx = FnCtxt::new(inherited, param_env, body.value.hir_id);
36 fcx.ps.set(UnsafetyState::function(fn_sig.unsafety, fn_id));
41 let declared_ret_ty = fn_sig.output();
44 fcx.register_infer_ok_obligations(fcx.infcx.replace_opaque_types_with_inference_vars(
51 fcx.ret_coercion = Some(RefCell::new(CoerceMany::new(ret_ty)));
53 let span = body.value.span;
55 fn_maybe_err(tcx, span, fn_sig.abi);
57 if body.generator_kind.is_some() && can_be_generator.is_some() {
59 .next_ty_var(TypeVariableOrigin { kind: TypeVariableOriginKind::TypeInference, span });
60 fcx.require_type_is_sized(yield_ty, span, traits::SizedYieldType);
62 // Resume type defaults to `()` if the generator has no argument.
63 let resume_ty = fn_sig.inputs().get(0).copied().unwrap_or_else(|| tcx.mk_unit());
65 fcx.resume_yield_tys = Some((resume_ty, yield_ty));
68 GatherLocalsVisitor::new(&fcx).visit_body(body);
70 // C-variadic fns also have a `VaList` input that's not listed in `fn_sig`
71 // (as it's created inside the body itself, not passed in from outside).
72 let maybe_va_list = if fn_sig.c_variadic {
73 let span = body.params.last().unwrap().span;
74 let va_list_did = tcx.require_lang_item(LangItem::VaList, Some(span));
75 let region = fcx.next_region_var(RegionVariableOrigin::MiscVariable(span));
77 Some(tcx.bound_type_of(va_list_did).subst(tcx, &[region.into()]))
82 // Add formal parameters.
83 let inputs_hir = hir.fn_decl_by_hir_id(fn_id).map(|decl| &decl.inputs);
84 let inputs_fn = fn_sig.inputs().iter().copied();
85 for (idx, (param_ty, param)) in inputs_fn.chain(maybe_va_list).zip(body.params).enumerate() {
87 let ty_span = try { inputs_hir?.get(idx)?.span };
88 fcx.check_pat_top(¶m.pat, param_ty, ty_span, false);
90 // Check that argument is Sized.
91 // The check for a non-trivial pattern is a hack to avoid duplicate warnings
92 // for simple cases like `fn foo(x: Trait)`,
93 // where we would error once on the parameter as a whole, and once on the binding `x`.
94 if param.pat.simple_ident().is_none() && !tcx.features().unsized_fn_params {
95 fcx.require_type_is_sized(param_ty, param.pat.span, traits::SizedArgumentType(ty_span));
98 fcx.write_ty(param.hir_id, param_ty);
101 inherited.typeck_results.borrow_mut().liberated_fn_sigs_mut().insert(fn_id, fn_sig);
103 if let ty::Dynamic(_, _, ty::Dyn) = declared_ret_ty.kind() {
104 // FIXME: We need to verify that the return type is `Sized` after the return expression has
105 // been evaluated so that we have types available for all the nodes being returned, but that
106 // requires the coerced evaluated type to be stored. Moving `check_return_expr` before this
107 // causes unsized errors caused by the `declared_ret_ty` to point at the return expression,
108 // while keeping the current ordering we will ignore the tail expression's type because we
109 // don't know it yet. We can't do `check_expr_kind` while keeping `check_return_expr`
110 // because we will trigger "unreachable expression" lints unconditionally.
111 // Because of all of this, we perform a crude check to know whether the simplest `!Sized`
112 // case that a newcomer might make, returning a bare trait, and in that case we populate
113 // the tail expression's type so that the suggestion will be correct, but ignore all other
115 fcx.check_expr(&body.value);
116 fcx.require_type_is_sized(declared_ret_ty, decl.output.span(), traits::SizedReturnType);
118 fcx.require_type_is_sized(declared_ret_ty, decl.output.span(), traits::SizedReturnType);
119 fcx.check_return_expr(&body.value, false);
122 // We insert the deferred_generator_interiors entry after visiting the body.
123 // This ensures that all nested generators appear before the entry of this generator.
124 // resolve_generator_interiors relies on this property.
125 let gen_ty = if let (Some(_), Some(gen_kind)) = (can_be_generator, body.generator_kind) {
127 .next_ty_var(TypeVariableOrigin { kind: TypeVariableOriginKind::MiscVariable, span });
128 fcx.deferred_generator_interiors.borrow_mut().push((body.id(), interior, gen_kind));
130 let (resume_ty, yield_ty) = fcx.resume_yield_tys.unwrap();
131 Some(GeneratorTypes {
135 movability: can_be_generator.unwrap(),
141 // Finalize the return check by taking the LUB of the return types
142 // we saw and assigning it to the expected return type. This isn't
143 // really expected to fail, since the coercions would have failed
144 // earlier when trying to find a LUB.
145 let coercion = fcx.ret_coercion.take().unwrap().into_inner();
146 let mut actual_return_ty = coercion.complete(&fcx);
147 debug!("actual_return_ty = {:?}", actual_return_ty);
148 if let ty::Dynamic(..) = declared_ret_ty.kind() {
149 // We have special-cased the case where the function is declared
150 // `-> dyn Foo` and we don't actually relate it to the
151 // `fcx.ret_coercion`, so just substitute a type variable.
153 fcx.next_ty_var(TypeVariableOrigin { kind: TypeVariableOriginKind::DynReturnFn, span });
154 debug!("actual_return_ty replaced with {:?}", actual_return_ty);
157 // HACK(oli-obk, compiler-errors): We should be comparing this against
158 // `declared_ret_ty`, but then anything uninferred would be inferred to
159 // the opaque type itself. That again would cause writeback to assume
160 // we have a recursive call site and do the sadly stabilized fallback to `()`.
161 fcx.demand_suptype(span, ret_ty, actual_return_ty);
163 // Check that a function marked as `#[panic_handler]` has signature `fn(&PanicInfo) -> !`
164 if let Some(panic_impl_did) = tcx.lang_items().panic_impl()
165 && panic_impl_did == hir.local_def_id(fn_id).to_def_id()
167 check_panic_info_fn(tcx, panic_impl_did.expect_local(), fn_sig, decl, declared_ret_ty);
173 fn check_panic_info_fn(
176 fn_sig: ty::FnSig<'_>,
177 decl: &hir::FnDecl<'_>,
178 declared_ret_ty: Ty<'_>,
180 let Some(panic_info_did) = tcx.lang_items().panic_info() else {
181 tcx.sess.err("language item required, but not found: `panic_info`");
185 if *declared_ret_ty.kind() != ty::Never {
186 tcx.sess.span_err(decl.output.span(), "return type should be `!`");
189 let inputs = fn_sig.inputs();
190 if inputs.len() != 1 {
191 tcx.sess.span_err(tcx.def_span(fn_id), "function should have one argument");
195 let arg_is_panic_info = match *inputs[0].kind() {
196 ty::Ref(region, ty, mutbl) => match *ty.kind() {
197 ty::Adt(ref adt, _) => {
198 adt.did() == panic_info_did && mutbl == hir::Mutability::Not && !region.is_static()
205 if !arg_is_panic_info {
206 tcx.sess.span_err(decl.inputs[0].span, "argument should be `&PanicInfo`");
209 let DefKind::Fn = tcx.def_kind(fn_id) else {
210 let span = tcx.def_span(fn_id);
211 tcx.sess.span_err(span, "should be a function");
215 let generic_counts = tcx.generics_of(fn_id).own_counts();
216 if generic_counts.types != 0 {
217 let span = tcx.def_span(fn_id);
218 tcx.sess.span_err(span, "should have no type parameters");
220 if generic_counts.consts != 0 {
221 let span = tcx.def_span(fn_id);
222 tcx.sess.span_err(span, "should have no const parameters");