rustc_borrowck/type_check/
input_output.rs

1//! This module contains code to equate the input/output types appearing
2//! in the MIR with the expected input/output types from the function
3//! signature. This requires a bit of processing, as the expected types
4//! are supplied to us before normalization and may contain opaque
5//! `impl Trait` instances. In contrast, the input/output types found in
6//! the MIR (specifically, in the special local variables for the
7//! `RETURN_PLACE` the MIR arguments) are always fully normalized (and
8//! contain revealed `impl Trait` values).
9
10use std::assert_matches::assert_matches;
11
12use itertools::Itertools;
13use rustc_hir as hir;
14use rustc_infer::infer::{BoundRegionConversionTime, RegionVariableOrigin};
15use rustc_middle::mir::*;
16use rustc_middle::ty::{self, Ty};
17use rustc_span::Span;
18use tracing::{debug, instrument};
19
20use super::{Locations, TypeChecker};
21use crate::renumber::RegionCtxt;
22use crate::universal_regions::DefiningTy;
23
24impl<'a, 'tcx> TypeChecker<'a, 'tcx> {
25    /// Check explicit closure signature annotation,
26    /// e.g., `|x: FxIndexMap<_, &'static u32>| ...`.
27    #[instrument(skip(self), level = "debug")]
28    pub(super) fn check_signature_annotation(&mut self) {
29        let mir_def_id = self.body.source.def_id().expect_local();
30
31        if !self.tcx().is_closure_like(mir_def_id.to_def_id()) {
32            return;
33        }
34
35        let user_provided_poly_sig = self.tcx().closure_user_provided_sig(mir_def_id);
36
37        // Instantiate the canonicalized variables from user-provided signature
38        // (e.g., the `_` in the code above) with fresh variables.
39        // Then replace the bound items in the fn sig with fresh variables,
40        // so that they represent the view from "inside" the closure.
41        let user_provided_sig = self.instantiate_canonical(self.body.span, &user_provided_poly_sig);
42        let mut user_provided_sig = self.infcx.instantiate_binder_with_fresh_vars(
43            self.body.span,
44            BoundRegionConversionTime::FnCall,
45            user_provided_sig,
46        );
47
48        // FIXME(async_closures): It's kind of wacky that we must apply this
49        // transformation here, since we do the same thing in HIR typeck.
50        // Maybe we could just fix up the canonicalized signature during HIR typeck?
51        if let DefiningTy::CoroutineClosure(_, args) = self.universal_regions.defining_ty {
52            assert_matches!(
53                self.tcx().coroutine_kind(self.tcx().coroutine_for_closure(mir_def_id)),
54                Some(hir::CoroutineKind::Desugared(
55                    hir::CoroutineDesugaring::Async | hir::CoroutineDesugaring::Gen,
56                    hir::CoroutineSource::Closure
57                )),
58                "this needs to be modified if we're lowering non-async closures"
59            );
60            // Make sure to use the args from `DefiningTy` so the right NLL region vids are
61            // prepopulated into the type.
62            let args = args.as_coroutine_closure();
63            let tupled_upvars_ty = ty::CoroutineClosureSignature::tupled_upvars_by_closure_kind(
64                self.tcx(),
65                args.kind(),
66                Ty::new_tup(self.tcx(), user_provided_sig.inputs()),
67                args.tupled_upvars_ty(),
68                args.coroutine_captures_by_ref_ty(),
69                self.infcx.next_region_var(RegionVariableOrigin::Misc(self.body.span), || {
70                    RegionCtxt::Unknown
71                }),
72            );
73
74            let next_ty_var = || self.infcx.next_ty_var(self.body.span);
75            let output_ty = Ty::new_coroutine(
76                self.tcx(),
77                self.tcx().coroutine_for_closure(mir_def_id),
78                ty::CoroutineArgs::new(
79                    self.tcx(),
80                    ty::CoroutineArgsParts {
81                        parent_args: args.parent_args(),
82                        kind_ty: Ty::from_coroutine_closure_kind(self.tcx(), args.kind()),
83                        return_ty: user_provided_sig.output(),
84                        tupled_upvars_ty,
85                        // For async closures, none of these can be annotated, so just fill
86                        // them with fresh ty vars.
87                        resume_ty: next_ty_var(),
88                        yield_ty: next_ty_var(),
89                    },
90                )
91                .args,
92            );
93
94            user_provided_sig = self.tcx().mk_fn_sig(
95                user_provided_sig.inputs().iter().copied(),
96                output_ty,
97                user_provided_sig.c_variadic,
98                user_provided_sig.safety,
99                user_provided_sig.abi,
100            );
101        }
102
103        let is_coroutine_with_implicit_resume_ty = self.tcx().is_coroutine(mir_def_id.to_def_id())
104            && user_provided_sig.inputs().is_empty();
105
106        for (&user_ty, arg_decl) in user_provided_sig.inputs().iter().zip_eq(
107            // In MIR, closure args begin with an implicit `self`.
108            // Also, coroutines have a resume type which may be implicitly `()`.
109            self.body
110                .args_iter()
111                .skip(1 + if is_coroutine_with_implicit_resume_ty { 1 } else { 0 })
112                .map(|local| &self.body.local_decls[local]),
113        ) {
114            self.ascribe_user_type_skip_wf(
115                arg_decl.ty,
116                ty::UserType::new(ty::UserTypeKind::Ty(user_ty)),
117                arg_decl.source_info.span,
118            );
119        }
120
121        // If the user explicitly annotated the output type, enforce it.
122        let output_decl = &self.body.local_decls[RETURN_PLACE];
123        self.ascribe_user_type_skip_wf(
124            output_decl.ty,
125            ty::UserType::new(ty::UserTypeKind::Ty(user_provided_sig.output())),
126            output_decl.source_info.span,
127        );
128    }
129
130    #[instrument(skip(self), level = "debug")]
131    pub(super) fn equate_inputs_and_outputs(&mut self, normalized_inputs_and_output: &[Ty<'tcx>]) {
132        let (&normalized_output_ty, normalized_input_tys) =
133            normalized_inputs_and_output.split_last().unwrap();
134
135        debug!(?normalized_output_ty);
136        debug!(?normalized_input_tys);
137
138        // Equate expected input tys with those in the MIR.
139        for (argument_index, &normalized_input_ty) in normalized_input_tys.iter().enumerate() {
140            if argument_index + 1 >= self.body.local_decls.len() {
141                self.tcx()
142                    .dcx()
143                    .span_bug(self.body.span, "found more normalized_input_ty than local_decls");
144            }
145
146            // In MIR, argument N is stored in local N+1.
147            let local = Local::from_usize(argument_index + 1);
148
149            let mir_input_ty = self.body.local_decls[local].ty;
150
151            let mir_input_span = self.body.local_decls[local].source_info.span;
152            self.equate_normalized_input_or_output(
153                normalized_input_ty,
154                mir_input_ty,
155                mir_input_span,
156            );
157        }
158
159        if let Some(mir_yield_ty) = self.body.yield_ty() {
160            let yield_span = self.body.local_decls[RETURN_PLACE].source_info.span;
161            self.equate_normalized_input_or_output(
162                self.universal_regions.yield_ty.unwrap(),
163                mir_yield_ty,
164                yield_span,
165            );
166        }
167
168        if let Some(mir_resume_ty) = self.body.resume_ty() {
169            let yield_span = self.body.local_decls[RETURN_PLACE].source_info.span;
170            self.equate_normalized_input_or_output(
171                self.universal_regions.resume_ty.unwrap(),
172                mir_resume_ty,
173                yield_span,
174            );
175        }
176
177        // Return types are a bit more complex. They may contain opaque `impl Trait` types.
178        let mir_output_ty = self.body.local_decls[RETURN_PLACE].ty;
179        let output_span = self.body.local_decls[RETURN_PLACE].source_info.span;
180        self.equate_normalized_input_or_output(normalized_output_ty, mir_output_ty, output_span);
181    }
182
183    #[instrument(skip(self), level = "debug")]
184    fn equate_normalized_input_or_output(&mut self, a: Ty<'tcx>, b: Ty<'tcx>, span: Span) {
185        if let Err(_) =
186            self.eq_types(a, b, Locations::All(span), ConstraintCategory::BoringNoLocation)
187        {
188            // FIXME(jackh726): This is a hack. It's somewhat like
189            // `rustc_traits::normalize_after_erasing_regions`. Ideally, we'd
190            // like to normalize *before* inserting into `local_decls`, but
191            // doing so ends up causing some other trouble.
192            let b = self.normalize(b, Locations::All(span));
193
194            // Note: if we have to introduce new placeholders during normalization above, then we
195            // won't have added those universes to the universe info, which we would want in
196            // `relate_tys`.
197            if let Err(terr) =
198                self.eq_types(a, b, Locations::All(span), ConstraintCategory::BoringNoLocation)
199            {
200                span_mirbug!(
201                    self,
202                    Location::START,
203                    "equate_normalized_input_or_output: `{:?}=={:?}` failed with `{:?}`",
204                    a,
205                    b,
206                    terr
207                );
208            }
209        }
210    }
211}
rustc_borrowck/type_check/input_output.rs

rustc_borrowck/type_check/
input_output.rs
