5 The type checker is responsible for:
7 1. Determining the type of each expression.
8 2. Resolving methods and traits.
9 3. Guaranteeing that most type rules are met. ("Most?", you say, "why most?"
10 Well, dear reader, read on.)
12 The main entry point is [`check_crate()`]. Type checking operates in
15 1. The collect phase first passes over all items and determines their
16 type, without examining their "innards".
18 2. Variance inference then runs to compute the variance of each parameter.
20 3. Coherence checks for overlapping or orphaned impls.
22 4. Finally, the check phase then checks function bodies and so forth.
23 Within the check phase, we check each function body one at a time
24 (bodies of function expressions are checked as part of the
25 containing function). Inference is used to supply types wherever
26 they are unknown. The actual checking of a function itself has
27 several phases (check, regionck, writeback), as discussed in the
28 documentation for the [`check`] module.
30 The type checker is defined into various submodules which are documented
33 - astconv: converts the AST representation of types
34 into the `ty` representation.
36 - collect: computes the types of each top-level item and enters them into
37 the `tcx.types` table for later use.
39 - coherence: enforces coherence rules, builds some tables.
41 - variance: variance inference
43 - outlives: outlives inference
45 - check: walks over function bodies and type checks them, inferring types for
46 local variables, type parameters, etc as necessary.
48 - infer: finds the types to use for each type variable such that
49 all subtyping and assignment constraints are met. In essence, the check
50 module specifies the constraints, and the infer module solves them.
54 This API is completely unstable and subject to change.
58 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")]
59 #![feature(bool_to_option)]
60 #![feature(crate_visibility_modifier)]
61 #![cfg_attr(bootstrap, feature(format_args_capture))]
62 #![feature(if_let_guard)]
63 #![feature(in_band_lifetimes)]
64 #![feature(is_sorted)]
67 #![feature(min_specialization)]
69 #![feature(try_blocks)]
70 #![feature(never_type)]
71 #![feature(slice_partition_dedup)]
72 #![feature(control_flow_enum)]
73 #![feature(hash_drain_filter)]
74 #![recursion_limit = "256"]
80 extern crate rustc_middle;
82 // These are used by Clippy.
84 pub mod expr_use_visitor;
91 mod constrained_generic_params;
95 mod mem_categorization;
97 mod structured_errors;
100 use rustc_errors::{struct_span_err, ErrorReported};
101 use rustc_hir as hir;
102 use rustc_hir::def_id::DefId;
103 use rustc_hir::{Node, CRATE_HIR_ID};
104 use rustc_infer::infer::{InferOk, TyCtxtInferExt};
105 use rustc_infer::traits::TraitEngineExt as _;
106 use rustc_middle::middle;
107 use rustc_middle::ty::query::Providers;
108 use rustc_middle::ty::{self, Ty, TyCtxt};
109 use rustc_middle::util;
110 use rustc_session::config::EntryFnType;
111 use rustc_span::{symbol::sym, Span, DUMMY_SP};
112 use rustc_target::spec::abi::Abi;
113 use rustc_trait_selection::infer::InferCtxtExt;
114 use rustc_trait_selection::traits::error_reporting::InferCtxtExt as _;
115 use rustc_trait_selection::traits::{
116 self, ObligationCause, ObligationCauseCode, TraitEngine, TraitEngineExt as _,
121 use astconv::AstConv;
124 fn require_c_abi_if_c_variadic(tcx: TyCtxt<'_>, decl: &hir::FnDecl<'_>, abi: Abi, span: Span) {
125 match (decl.c_variadic, abi) {
126 // The function has the correct calling convention, or isn't a "C-variadic" function.
127 (false, _) | (true, Abi::C { .. }) | (true, Abi::Cdecl) => {}
128 // The function is a "C-variadic" function with an incorrect calling convention.
130 let mut err = struct_span_err!(
134 "C-variadic function must have C or cdecl calling convention"
136 err.span_label(span, "C-variadics require C or cdecl calling convention").emit();
141 fn require_same_types<'tcx>(
143 cause: &ObligationCause<'tcx>,
147 tcx.infer_ctxt().enter(|ref infcx| {
148 let param_env = ty::ParamEnv::empty();
149 let mut fulfill_cx = <dyn TraitEngine<'_>>::new(infcx.tcx);
150 match infcx.at(cause, param_env).eq(expected, actual) {
151 Ok(InferOk { obligations, .. }) => {
152 fulfill_cx.register_predicate_obligations(infcx, obligations);
155 infcx.report_mismatched_types(cause, expected, actual, err).emit();
160 match fulfill_cx.select_all_or_error(infcx).as_slice() {
163 infcx.report_fulfillment_errors(errors, None, false);
170 fn check_main_fn_ty(tcx: TyCtxt<'_>, main_def_id: DefId) {
171 let main_fnsig = tcx.fn_sig(main_def_id);
172 let main_span = tcx.def_span(main_def_id);
174 fn main_fn_diagnostics_hir_id(tcx: TyCtxt<'_>, def_id: DefId, sp: Span) -> hir::HirId {
175 if let Some(local_def_id) = def_id.as_local() {
176 let hir_id = tcx.hir().local_def_id_to_hir_id(local_def_id);
177 let hir_type = tcx.type_of(local_def_id);
178 if !matches!(hir_type.kind(), ty::FnDef(..)) {
179 span_bug!(sp, "main has a non-function type: found `{}`", hir_type);
187 fn main_fn_generics_params_span(tcx: TyCtxt<'_>, def_id: DefId) -> Option<Span> {
188 if !def_id.is_local() {
191 let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
192 match tcx.hir().find(hir_id) {
193 Some(Node::Item(hir::Item { kind: hir::ItemKind::Fn(_, ref generics, _), .. })) => {
194 if !generics.params.is_empty() {
201 span_bug!(tcx.def_span(def_id), "main has a non-function type");
206 fn main_fn_where_clauses_span(tcx: TyCtxt<'_>, def_id: DefId) -> Option<Span> {
207 if !def_id.is_local() {
210 let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
211 match tcx.hir().find(hir_id) {
212 Some(Node::Item(hir::Item { kind: hir::ItemKind::Fn(_, ref generics, _), .. })) => {
213 generics.where_clause.span()
216 span_bug!(tcx.def_span(def_id), "main has a non-function type");
221 fn main_fn_asyncness_span(tcx: TyCtxt<'_>, def_id: DefId) -> Option<Span> {
222 if !def_id.is_local() {
225 let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
226 match tcx.hir().find(hir_id) {
227 Some(Node::Item(hir::Item { span: item_span, .. })) => {
228 Some(tcx.sess.source_map().guess_head_span(*item_span))
231 span_bug!(tcx.def_span(def_id), "main has a non-function type");
236 fn main_fn_return_type_span(tcx: TyCtxt<'_>, def_id: DefId) -> Option<Span> {
237 if !def_id.is_local() {
240 let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
241 match tcx.hir().find(hir_id) {
242 Some(Node::Item(hir::Item { kind: hir::ItemKind::Fn(ref fn_sig, _, _), .. })) => {
243 Some(fn_sig.decl.output.span())
246 span_bug!(tcx.def_span(def_id), "main has a non-function type");
251 let mut error = false;
252 let main_diagnostics_hir_id = main_fn_diagnostics_hir_id(tcx, main_def_id, main_span);
253 let main_fn_generics = tcx.generics_of(main_def_id);
254 let main_fn_predicates = tcx.predicates_of(main_def_id);
255 if main_fn_generics.count() != 0 || !main_fnsig.bound_vars().is_empty() {
256 let generics_param_span = main_fn_generics_params_span(tcx, main_def_id);
257 let msg = "`main` function is not allowed to have generic \
260 struct_span_err!(tcx.sess, generics_param_span.unwrap_or(main_span), E0131, "{}", msg);
261 if let Some(generics_param_span) = generics_param_span {
262 let label = "`main` cannot have generic parameters".to_string();
263 diag.span_label(generics_param_span, label);
267 } else if !main_fn_predicates.predicates.is_empty() {
268 // generics may bring in implicit predicates, so we skip this check if generics is present.
269 let generics_where_clauses_span = main_fn_where_clauses_span(tcx, main_def_id);
270 let mut diag = struct_span_err!(
272 generics_where_clauses_span.unwrap_or(main_span),
274 "`main` function is not allowed to have a `where` clause"
276 if let Some(generics_where_clauses_span) = generics_where_clauses_span {
277 diag.span_label(generics_where_clauses_span, "`main` cannot have a `where` clause");
283 let main_asyncness = tcx.asyncness(main_def_id);
284 if let hir::IsAsync::Async = main_asyncness {
285 let mut diag = struct_span_err!(
289 "`main` function is not allowed to be `async`"
291 let asyncness_span = main_fn_asyncness_span(tcx, main_def_id);
292 if let Some(asyncness_span) = asyncness_span {
293 diag.span_label(asyncness_span, "`main` function is not allowed to be `async`");
299 for attr in tcx.get_attrs(main_def_id) {
300 if attr.has_name(sym::track_caller) {
304 "`main` function is not allowed to be `#[track_caller]`",
306 .span_label(main_span, "`main` function is not allowed to be `#[track_caller]`")
316 let expected_return_type;
317 if let Some(term_id) = tcx.lang_items().termination() {
318 let return_ty = main_fnsig.output();
319 let return_ty_span = main_fn_return_type_span(tcx, main_def_id).unwrap_or(main_span);
320 if !return_ty.bound_vars().is_empty() {
321 let msg = "`main` function return type is not allowed to have generic \
324 struct_span_err!(tcx.sess, return_ty_span, E0131, "{}", msg).emit();
327 let return_ty = return_ty.skip_binder();
328 tcx.infer_ctxt().enter(|infcx| {
329 let cause = traits::ObligationCause::new(
331 main_diagnostics_hir_id,
332 ObligationCauseCode::MainFunctionType,
334 let mut fulfillment_cx = traits::FulfillmentContext::new();
335 // normalize any potential projections in the return type, then add
336 // any possible obligations to the fulfillment context.
337 // HACK(ThePuzzlemaker) this feels symptomatic of a problem within
338 // checking trait fulfillment, not this here. I'm not sure why it
339 // works in the example in `fn test()` given in #88609? This also
340 // probably isn't the best way to do this.
341 let InferOk { value: norm_return_ty, obligations } = infcx
342 .partially_normalize_associated_types_in(
344 ty::ParamEnv::empty(),
347 fulfillment_cx.register_predicate_obligations(&infcx, obligations);
348 fulfillment_cx.register_bound(
350 ty::ParamEnv::empty(),
355 let errors = fulfillment_cx.select_all_or_error(&infcx);
356 if !errors.is_empty() {
357 infcx.report_fulfillment_errors(&errors, None, false);
361 // now we can take the return type of the given main function
362 expected_return_type = main_fnsig.output();
364 // standard () main return type
365 expected_return_type = ty::Binder::dummy(tcx.mk_unit());
372 let se_ty = tcx.mk_fn_ptr(expected_return_type.map_bound(|expected_return_type| {
373 tcx.mk_fn_sig(iter::empty(), expected_return_type, false, hir::Unsafety::Normal, Abi::Rust)
378 &ObligationCause::new(
380 main_diagnostics_hir_id,
381 ObligationCauseCode::MainFunctionType,
384 tcx.mk_fn_ptr(main_fnsig),
387 fn check_start_fn_ty(tcx: TyCtxt<'_>, start_def_id: DefId) {
388 let start_def_id = start_def_id.expect_local();
389 let start_id = tcx.hir().local_def_id_to_hir_id(start_def_id);
390 let start_span = tcx.def_span(start_def_id);
391 let start_t = tcx.type_of(start_def_id);
392 match start_t.kind() {
394 if let Some(Node::Item(it)) = tcx.hir().find(start_id) {
395 if let hir::ItemKind::Fn(ref sig, ref generics, _) = it.kind {
396 let mut error = false;
397 if !generics.params.is_empty() {
402 "start function is not allowed to have type parameters"
404 .span_label(generics.span, "start function cannot have type parameters")
408 if let Some(sp) = generics.where_clause.span() {
413 "start function is not allowed to have a `where` clause"
415 .span_label(sp, "start function cannot have a `where` clause")
419 if let hir::IsAsync::Async = sig.header.asyncness {
420 let span = tcx.sess.source_map().guess_head_span(it.span);
425 "`start` is not allowed to be `async`"
427 .span_label(span, "`start` is not allowed to be `async`")
432 let attrs = tcx.hir().attrs(start_id);
434 if attr.has_name(sym::track_caller) {
438 "`start` is not allowed to be `#[track_caller]`",
442 "`start` is not allowed to be `#[track_caller]`",
455 let se_ty = tcx.mk_fn_ptr(ty::Binder::dummy(tcx.mk_fn_sig(
456 [tcx.types.isize, tcx.mk_imm_ptr(tcx.mk_imm_ptr(tcx.types.u8))].iter().cloned(),
459 hir::Unsafety::Normal,
465 &ObligationCause::new(start_span, start_id, ObligationCauseCode::StartFunctionType),
467 tcx.mk_fn_ptr(tcx.fn_sig(start_def_id)),
471 span_bug!(start_span, "start has a non-function type: found `{}`", start_t);
476 fn check_for_entry_fn(tcx: TyCtxt<'_>) {
477 match tcx.entry_fn(()) {
478 Some((def_id, EntryFnType::Main)) => check_main_fn_ty(tcx, def_id),
479 Some((def_id, EntryFnType::Start)) => check_start_fn_ty(tcx, def_id),
484 pub fn provide(providers: &mut Providers) {
485 collect::provide(providers);
486 coherence::provide(providers);
487 check::provide(providers);
488 variance::provide(providers);
489 outlives::provide(providers);
490 impl_wf_check::provide(providers);
491 hir_wf_check::provide(providers);
494 pub fn check_crate(tcx: TyCtxt<'_>) -> Result<(), ErrorReported> {
495 let _prof_timer = tcx.sess.timer("type_check_crate");
497 // this ensures that later parts of type checking can assume that items
498 // have valid types and not error
499 // FIXME(matthewjasper) We shouldn't need to use `track_errors`.
500 tcx.sess.track_errors(|| {
501 tcx.sess.time("type_collecting", || {
502 tcx.hir().for_each_module(|module| tcx.ensure().collect_mod_item_types(module))
506 if tcx.features().rustc_attrs {
507 tcx.sess.track_errors(|| {
508 tcx.sess.time("outlives_testing", || outlives::test::test_inferred_outlives(tcx));
512 tcx.sess.track_errors(|| {
513 tcx.sess.time("impl_wf_inference", || impl_wf_check::impl_wf_check(tcx));
516 tcx.sess.track_errors(|| {
517 tcx.sess.time("coherence_checking", || coherence::check_coherence(tcx));
520 if tcx.features().rustc_attrs {
521 tcx.sess.track_errors(|| {
522 tcx.sess.time("variance_testing", || variance::test::test_variance(tcx));
526 tcx.sess.track_errors(|| {
527 tcx.sess.time("wf_checking", || check::check_wf_new(tcx));
530 // NOTE: This is copy/pasted in librustdoc/core.rs and should be kept in sync.
531 tcx.sess.time("item_types_checking", || {
532 tcx.hir().for_each_module(|module| tcx.ensure().check_mod_item_types(module))
535 tcx.sess.time("item_bodies_checking", || tcx.typeck_item_bodies(()));
537 check_unused::check_crate(tcx);
538 check_for_entry_fn(tcx);
540 if tcx.sess.err_count() == 0 { Ok(()) } else { Err(ErrorReported) }
543 /// A quasi-deprecated helper used in rustdoc and clippy to get
544 /// the type from a HIR node.
545 pub fn hir_ty_to_ty<'tcx>(tcx: TyCtxt<'tcx>, hir_ty: &hir::Ty<'_>) -> Ty<'tcx> {
546 // In case there are any projections, etc., find the "environment"
547 // def-ID that will be used to determine the traits/predicates in
548 // scope. This is derived from the enclosing item-like thing.
549 let env_node_id = tcx.hir().get_parent_item(hir_ty.hir_id);
550 let env_def_id = tcx.hir().local_def_id(env_node_id);
551 let item_cx = self::collect::ItemCtxt::new(tcx, env_def_id.to_def_id());
552 <dyn AstConv<'_>>::ast_ty_to_ty(&item_cx, hir_ty)
555 pub fn hir_trait_to_predicates<'tcx>(
557 hir_trait: &hir::TraitRef<'_>,
560 // In case there are any projections, etc., find the "environment"
561 // def-ID that will be used to determine the traits/predicates in
562 // scope. This is derived from the enclosing item-like thing.
563 let env_hir_id = tcx.hir().get_parent_item(hir_trait.hir_ref_id);
564 let env_def_id = tcx.hir().local_def_id(env_hir_id);
565 let item_cx = self::collect::ItemCtxt::new(tcx, env_def_id.to_def_id());
566 let mut bounds = Bounds::default();
567 let _ = <dyn AstConv<'_>>::instantiate_poly_trait_ref(
571 ty::BoundConstness::NotConst,