compiler/rustc_typeck/src/lib.rs

   1 /*!
   2
   3 # typeck
   4
   5 The type checker is responsible for:
   6
   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.)
  11
  12 The main entry point is [`check_crate()`]. Type checking operates in
  13 several major phases:
  14
  15 1. The collect phase first passes over all items and determines their
  16    type, without examining their "innards".
  17
  18 2. Variance inference then runs to compute the variance of each parameter.
  19
  20 3. Coherence checks for overlapping or orphaned impls.
  21
  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.
  29
  30 The type checker is defined into various submodules which are documented
  31 independently:
  32
  33 - astconv: converts the AST representation of types
  34   into the `ty` representation.
  35
  36 - collect: computes the types of each top-level item and enters them into
  37   the `tcx.types` table for later use.
  38
  39 - coherence: enforces coherence rules, builds some tables.
  40
  41 - variance: variance inference
  42
  43 - outlives: outlives inference
  44
  45 - check: walks over function bodies and type checks them, inferring types for
  46   local variables, type parameters, etc as necessary.
  47
  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.
  51
  52 ## Note
  53
  54 This API is completely unstable and subject to change.
  55
  56 */
  57
  58 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")]
  59 #![feature(bool_to_option)]
  60 #![feature(crate_visibility_modifier)]
  61 #![feature(if_let_guard)]
  62 #![feature(is_sorted)]
  63 #![feature(let_else)]
  64 #![feature(min_specialization)]
  65 #![feature(nll)]
  66 #![feature(try_blocks)]
  67 #![feature(never_type)]
  68 #![feature(slice_partition_dedup)]
  69 #![feature(control_flow_enum)]
  70 #![feature(hash_drain_filter)]
  71 #![recursion_limit = "256"]
  72 #![cfg_attr(not(bootstrap), allow(rustc::potential_query_instability))]
  73
  74 #[macro_use]
  75 extern crate tracing;
  76
  77 #[macro_use]
  78 extern crate rustc_middle;
  79
  80 // These are used by Clippy.
  81 pub mod check;
  82 pub mod expr_use_visitor;
  83
  84 mod astconv;
  85 mod bounds;
  86 mod check_unused;
  87 mod coherence;
  88 mod collect;
  89 mod constrained_generic_params;
  90 mod errors;
  91 pub mod hir_wf_check;
  92 mod impl_wf_check;
  93 mod mem_categorization;
  94 mod outlives;
  95 mod structured_errors;
  96 mod variance;
  97
  98 use rustc_errors::{struct_span_err, ErrorReported};
  99 use rustc_hir as hir;
 100 use rustc_hir::def_id::DefId;
 101 use rustc_hir::{Node, CRATE_HIR_ID};
 102 use rustc_infer::infer::{InferOk, TyCtxtInferExt};
 103 use rustc_infer::traits::TraitEngineExt as _;
 104 use rustc_middle::middle;
 105 use rustc_middle::ty::query::Providers;
 106 use rustc_middle::ty::{self, Ty, TyCtxt};
 107 use rustc_middle::util;
 108 use rustc_session::config::EntryFnType;
 109 use rustc_span::{symbol::sym, Span, DUMMY_SP};
 110 use rustc_target::spec::abi::Abi;
 111 use rustc_trait_selection::infer::InferCtxtExt;
 112 use rustc_trait_selection::traits::error_reporting::InferCtxtExt as _;
 113 use rustc_trait_selection::traits::{
 114     self, ObligationCause, ObligationCauseCode, TraitEngine, TraitEngineExt as _,
 115 };
 116
 117 use std::iter;
 118
 119 use astconv::AstConv;
 120 use bounds::Bounds;
 121
 122 fn require_c_abi_if_c_variadic(tcx: TyCtxt<'_>, decl: &hir::FnDecl<'_>, abi: Abi, span: Span) {
 123     match (decl.c_variadic, abi) {
 124         // The function has the correct calling convention, or isn't a "C-variadic" function.
 125         (false, _) | (true, Abi::C { .. }) | (true, Abi::Cdecl) => {}
 126         // The function is a "C-variadic" function with an incorrect calling convention.
 127         (true, _) => {
 128             let mut err = struct_span_err!(
 129                 tcx.sess,
 130                 span,
 131                 E0045,
 132                 "C-variadic function must have C or cdecl calling convention"
 133             );
 134             err.span_label(span, "C-variadics require C or cdecl calling convention").emit();
 135         }
 136     }
 137 }
 138
 139 fn require_same_types<'tcx>(
 140     tcx: TyCtxt<'tcx>,
 141     cause: &ObligationCause<'tcx>,
 142     expected: Ty<'tcx>,
 143     actual: Ty<'tcx>,
 144 ) -> bool {
 145     tcx.infer_ctxt().enter(|ref infcx| {
 146         let param_env = ty::ParamEnv::empty();
 147         let mut fulfill_cx = <dyn TraitEngine<'_>>::new(infcx.tcx);
 148         match infcx.at(cause, param_env).eq(expected, actual) {
 149             Ok(InferOk { obligations, .. }) => {
 150                 fulfill_cx.register_predicate_obligations(infcx, obligations);
 151             }
 152             Err(err) => {
 153                 infcx.report_mismatched_types(cause, expected, actual, err).emit();
 154                 return false;
 155             }
 156         }
 157
 158         match fulfill_cx.select_all_or_error(infcx).as_slice() {
 159             [] => true,
 160             errors => {
 161                 infcx.report_fulfillment_errors(errors, None, false);
 162                 false
 163             }
 164         }
 165     })
 166 }
 167
 168 fn check_main_fn_ty(tcx: TyCtxt<'_>, main_def_id: DefId) {
 169     let main_fnsig = tcx.fn_sig(main_def_id);
 170     let main_span = tcx.def_span(main_def_id);
 171
 172     fn main_fn_diagnostics_hir_id(tcx: TyCtxt<'_>, def_id: DefId, sp: Span) -> hir::HirId {
 173         if let Some(local_def_id) = def_id.as_local() {
 174             let hir_id = tcx.hir().local_def_id_to_hir_id(local_def_id);
 175             let hir_type = tcx.type_of(local_def_id);
 176             if !matches!(hir_type.kind(), ty::FnDef(..)) {
 177                 span_bug!(sp, "main has a non-function type: found `{}`", hir_type);
 178             }
 179             hir_id
 180         } else {
 181             CRATE_HIR_ID
 182         }
 183     }
 184
 185     fn main_fn_generics_params_span(tcx: TyCtxt<'_>, def_id: DefId) -> Option<Span> {
 186         if !def_id.is_local() {
 187             return None;
 188         }
 189         let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
 190         match tcx.hir().find(hir_id) {
 191             Some(Node::Item(hir::Item { kind: hir::ItemKind::Fn(_, ref generics, _), .. })) => {
 192                 if !generics.params.is_empty() {
 193                     Some(generics.span)
 194                 } else {
 195                     None
 196                 }
 197             }
 198             _ => {
 199                 span_bug!(tcx.def_span(def_id), "main has a non-function type");
 200             }
 201         }
 202     }
 203
 204     fn main_fn_where_clauses_span(tcx: TyCtxt<'_>, def_id: DefId) -> Option<Span> {
 205         if !def_id.is_local() {
 206             return None;
 207         }
 208         let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
 209         match tcx.hir().find(hir_id) {
 210             Some(Node::Item(hir::Item { kind: hir::ItemKind::Fn(_, ref generics, _), .. })) => {
 211                 generics.where_clause.span()
 212             }
 213             _ => {
 214                 span_bug!(tcx.def_span(def_id), "main has a non-function type");
 215             }
 216         }
 217     }
 218
 219     fn main_fn_asyncness_span(tcx: TyCtxt<'_>, def_id: DefId) -> Option<Span> {
 220         if !def_id.is_local() {
 221             return None;
 222         }
 223         let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
 224         match tcx.hir().find(hir_id) {
 225             Some(Node::Item(hir::Item { span: item_span, .. })) => {
 226                 Some(tcx.sess.source_map().guess_head_span(*item_span))
 227             }
 228             _ => {
 229                 span_bug!(tcx.def_span(def_id), "main has a non-function type");
 230             }
 231         }
 232     }
 233
 234     fn main_fn_return_type_span(tcx: TyCtxt<'_>, def_id: DefId) -> Option<Span> {
 235         if !def_id.is_local() {
 236             return None;
 237         }
 238         let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
 239         match tcx.hir().find(hir_id) {
 240             Some(Node::Item(hir::Item { kind: hir::ItemKind::Fn(ref fn_sig, _, _), .. })) => {
 241                 Some(fn_sig.decl.output.span())
 242             }
 243             _ => {
 244                 span_bug!(tcx.def_span(def_id), "main has a non-function type");
 245             }
 246         }
 247     }
 248
 249     let mut error = false;
 250     let main_diagnostics_hir_id = main_fn_diagnostics_hir_id(tcx, main_def_id, main_span);
 251     let main_fn_generics = tcx.generics_of(main_def_id);
 252     let main_fn_predicates = tcx.predicates_of(main_def_id);
 253     if main_fn_generics.count() != 0 || !main_fnsig.bound_vars().is_empty() {
 254         let generics_param_span = main_fn_generics_params_span(tcx, main_def_id);
 255         let msg = "`main` function is not allowed to have generic \
 256             parameters";
 257         let mut diag =
 258             struct_span_err!(tcx.sess, generics_param_span.unwrap_or(main_span), E0131, "{}", msg);
 259         if let Some(generics_param_span) = generics_param_span {
 260             let label = "`main` cannot have generic parameters".to_string();
 261             diag.span_label(generics_param_span, label);
 262         }
 263         diag.emit();
 264         error = true;
 265     } else if !main_fn_predicates.predicates.is_empty() {
 266         // generics may bring in implicit predicates, so we skip this check if generics is present.
 267         let generics_where_clauses_span = main_fn_where_clauses_span(tcx, main_def_id);
 268         let mut diag = struct_span_err!(
 269             tcx.sess,
 270             generics_where_clauses_span.unwrap_or(main_span),
 271             E0646,
 272             "`main` function is not allowed to have a `where` clause"
 273         );
 274         if let Some(generics_where_clauses_span) = generics_where_clauses_span {
 275             diag.span_label(generics_where_clauses_span, "`main` cannot have a `where` clause");
 276         }
 277         diag.emit();
 278         error = true;
 279     }
 280
 281     let main_asyncness = tcx.asyncness(main_def_id);
 282     if let hir::IsAsync::Async = main_asyncness {
 283         let mut diag = struct_span_err!(
 284             tcx.sess,
 285             main_span,
 286             E0752,
 287             "`main` function is not allowed to be `async`"
 288         );
 289         let asyncness_span = main_fn_asyncness_span(tcx, main_def_id);
 290         if let Some(asyncness_span) = asyncness_span {
 291             diag.span_label(asyncness_span, "`main` function is not allowed to be `async`");
 292         }
 293         diag.emit();
 294         error = true;
 295     }
 296
 297     for attr in tcx.get_attrs(main_def_id) {
 298         if attr.has_name(sym::track_caller) {
 299             tcx.sess
 300                 .struct_span_err(
 301                     attr.span,
 302                     "`main` function is not allowed to be `#[track_caller]`",
 303                 )
 304                 .span_label(main_span, "`main` function is not allowed to be `#[track_caller]`")
 305                 .emit();
 306             error = true;
 307         }
 308     }
 309
 310     if error {
 311         return;
 312     }
 313
 314     let expected_return_type;
 315     if let Some(term_id) = tcx.lang_items().termination() {
 316         let return_ty = main_fnsig.output();
 317         let return_ty_span = main_fn_return_type_span(tcx, main_def_id).unwrap_or(main_span);
 318         if !return_ty.bound_vars().is_empty() {
 319             let msg = "`main` function return type is not allowed to have generic \
 320                     parameters"
 321                 .to_owned();
 322             struct_span_err!(tcx.sess, return_ty_span, E0131, "{}", msg).emit();
 323             error = true;
 324         }
 325         let return_ty = return_ty.skip_binder();
 326         tcx.infer_ctxt().enter(|infcx| {
 327             let cause = traits::ObligationCause::new(
 328                 return_ty_span,
 329                 main_diagnostics_hir_id,
 330                 ObligationCauseCode::MainFunctionType,
 331             );
 332             let mut fulfillment_cx = traits::FulfillmentContext::new();
 333             // normalize any potential projections in the return type, then add
 334             // any possible obligations to the fulfillment context.
 335             // HACK(ThePuzzlemaker) this feels symptomatic of a problem within
 336             // checking trait fulfillment, not this here. I'm not sure why it
 337             // works in the example in `fn test()` given in #88609? This also
 338             // probably isn't the best way to do this.
 339             let InferOk { value: norm_return_ty, obligations } = infcx
 340                 .partially_normalize_associated_types_in(
 341                     cause.clone(),
 342                     ty::ParamEnv::empty(),
 343                     return_ty,
 344                 );
 345             fulfillment_cx.register_predicate_obligations(&infcx, obligations);
 346             fulfillment_cx.register_bound(
 347                 &infcx,
 348                 ty::ParamEnv::empty(),
 349                 norm_return_ty,
 350                 term_id,
 351                 cause,
 352             );
 353             let errors = fulfillment_cx.select_all_or_error(&infcx);
 354             if !errors.is_empty() {
 355                 infcx.report_fulfillment_errors(&errors, None, false);
 356                 error = true;
 357             }
 358         });
 359         // now we can take the return type of the given main function
 360         expected_return_type = main_fnsig.output();
 361     } else {
 362         // standard () main return type
 363         expected_return_type = ty::Binder::dummy(tcx.mk_unit());
 364     }
 365
 366     if error {
 367         return;
 368     }
 369
 370     let se_ty = tcx.mk_fn_ptr(expected_return_type.map_bound(|expected_return_type| {
 371         tcx.mk_fn_sig(iter::empty(), expected_return_type, false, hir::Unsafety::Normal, Abi::Rust)
 372     }));
 373
 374     require_same_types(
 375         tcx,
 376         &ObligationCause::new(
 377             main_span,
 378             main_diagnostics_hir_id,
 379             ObligationCauseCode::MainFunctionType,
 380         ),
 381         se_ty,
 382         tcx.mk_fn_ptr(main_fnsig),
 383     );
 384 }
 385 fn check_start_fn_ty(tcx: TyCtxt<'_>, start_def_id: DefId) {
 386     let start_def_id = start_def_id.expect_local();
 387     let start_id = tcx.hir().local_def_id_to_hir_id(start_def_id);
 388     let start_span = tcx.def_span(start_def_id);
 389     let start_t = tcx.type_of(start_def_id);
 390     match start_t.kind() {
 391         ty::FnDef(..) => {
 392             if let Some(Node::Item(it)) = tcx.hir().find(start_id) {
 393                 if let hir::ItemKind::Fn(ref sig, ref generics, _) = it.kind {
 394                     let mut error = false;
 395                     if !generics.params.is_empty() {
 396                         struct_span_err!(
 397                             tcx.sess,
 398                             generics.span,
 399                             E0132,
 400                             "start function is not allowed to have type parameters"
 401                         )
 402                         .span_label(generics.span, "start function cannot have type parameters")
 403                         .emit();
 404                         error = true;
 405                     }
 406                     if let Some(sp) = generics.where_clause.span() {
 407                         struct_span_err!(
 408                             tcx.sess,
 409                             sp,
 410                             E0647,
 411                             "start function is not allowed to have a `where` clause"
 412                         )
 413                         .span_label(sp, "start function cannot have a `where` clause")
 414                         .emit();
 415                         error = true;
 416                     }
 417                     if let hir::IsAsync::Async = sig.header.asyncness {
 418                         let span = tcx.sess.source_map().guess_head_span(it.span);
 419                         struct_span_err!(
 420                             tcx.sess,
 421                             span,
 422                             E0752,
 423                             "`start` is not allowed to be `async`"
 424                         )
 425                         .span_label(span, "`start` is not allowed to be `async`")
 426                         .emit();
 427                         error = true;
 428                     }
 429
 430                     let attrs = tcx.hir().attrs(start_id);
 431                     for attr in attrs {
 432                         if attr.has_name(sym::track_caller) {
 433                             tcx.sess
 434                                 .struct_span_err(
 435                                     attr.span,
 436                                     "`start` is not allowed to be `#[track_caller]`",
 437                                 )
 438                                 .span_label(
 439                                     start_span,
 440                                     "`start` is not allowed to be `#[track_caller]`",
 441                                 )
 442                                 .emit();
 443                             error = true;
 444                         }
 445                     }
 446
 447                     if error {
 448                         return;
 449                     }
 450                 }
 451             }
 452
 453             let se_ty = tcx.mk_fn_ptr(ty::Binder::dummy(tcx.mk_fn_sig(
 454                 [tcx.types.isize, tcx.mk_imm_ptr(tcx.mk_imm_ptr(tcx.types.u8))].iter().cloned(),
 455                 tcx.types.isize,
 456                 false,
 457                 hir::Unsafety::Normal,
 458                 Abi::Rust,
 459             )));
 460
 461             require_same_types(
 462                 tcx,
 463                 &ObligationCause::new(start_span, start_id, ObligationCauseCode::StartFunctionType),
 464                 se_ty,
 465                 tcx.mk_fn_ptr(tcx.fn_sig(start_def_id)),
 466             );
 467         }
 468         _ => {
 469             span_bug!(start_span, "start has a non-function type: found `{}`", start_t);
 470         }
 471     }
 472 }
 473
 474 fn check_for_entry_fn(tcx: TyCtxt<'_>) {
 475     match tcx.entry_fn(()) {
 476         Some((def_id, EntryFnType::Main)) => check_main_fn_ty(tcx, def_id),
 477         Some((def_id, EntryFnType::Start)) => check_start_fn_ty(tcx, def_id),
 478         _ => {}
 479     }
 480 }
 481
 482 pub fn provide(providers: &mut Providers) {
 483     collect::provide(providers);
 484     coherence::provide(providers);
 485     check::provide(providers);
 486     variance::provide(providers);
 487     outlives::provide(providers);
 488     impl_wf_check::provide(providers);
 489     hir_wf_check::provide(providers);
 490 }
 491
 492 pub fn check_crate(tcx: TyCtxt<'_>) -> Result<(), ErrorReported> {
 493     let _prof_timer = tcx.sess.timer("type_check_crate");
 494
 495     // this ensures that later parts of type checking can assume that items
 496     // have valid types and not error
 497     // FIXME(matthewjasper) We shouldn't need to use `track_errors`.
 498     tcx.sess.track_errors(|| {
 499         tcx.sess.time("type_collecting", || {
 500             tcx.hir().for_each_module(|module| tcx.ensure().collect_mod_item_types(module))
 501         });
 502     })?;
 503
 504     if tcx.features().rustc_attrs {
 505         tcx.sess.track_errors(|| {
 506             tcx.sess.time("outlives_testing", || outlives::test::test_inferred_outlives(tcx));
 507         })?;
 508     }
 509
 510     tcx.sess.track_errors(|| {
 511         tcx.sess.time("impl_wf_inference", || impl_wf_check::impl_wf_check(tcx));
 512     })?;
 513
 514     tcx.sess.track_errors(|| {
 515         tcx.sess.time("coherence_checking", || coherence::check_coherence(tcx));
 516     })?;
 517
 518     if tcx.features().rustc_attrs {
 519         tcx.sess.track_errors(|| {
 520             tcx.sess.time("variance_testing", || variance::test::test_variance(tcx));
 521         })?;
 522     }
 523
 524     tcx.sess.track_errors(|| {
 525         tcx.sess.time("wf_checking", || check::check_wf_new(tcx));
 526     })?;
 527
 528     // NOTE: This is copy/pasted in librustdoc/core.rs and should be kept in sync.
 529     tcx.sess.time("item_types_checking", || {
 530         tcx.hir().for_each_module(|module| tcx.ensure().check_mod_item_types(module))
 531     });
 532
 533     tcx.sess.time("item_bodies_checking", || tcx.typeck_item_bodies(()));
 534
 535     check_unused::check_crate(tcx);
 536     check_for_entry_fn(tcx);
 537
 538     if tcx.sess.err_count() == 0 { Ok(()) } else { Err(ErrorReported) }
 539 }
 540
 541 /// A quasi-deprecated helper used in rustdoc and clippy to get
 542 /// the type from a HIR node.
 543 pub fn hir_ty_to_ty<'tcx>(tcx: TyCtxt<'tcx>, hir_ty: &hir::Ty<'_>) -> Ty<'tcx> {
 544     // In case there are any projections, etc., find the "environment"
 545     // def-ID that will be used to determine the traits/predicates in
 546     // scope.  This is derived from the enclosing item-like thing.
 547     let env_def_id = tcx.hir().get_parent_item(hir_ty.hir_id);
 548     let item_cx = self::collect::ItemCtxt::new(tcx, env_def_id.to_def_id());
 549     <dyn AstConv<'_>>::ast_ty_to_ty(&item_cx, hir_ty)
 550 }
 551
 552 pub fn hir_trait_to_predicates<'tcx>(
 553     tcx: TyCtxt<'tcx>,
 554     hir_trait: &hir::TraitRef<'_>,
 555     self_ty: Ty<'tcx>,
 556 ) -> Bounds<'tcx> {
 557     // In case there are any projections, etc., find the "environment"
 558     // def-ID that will be used to determine the traits/predicates in
 559     // scope.  This is derived from the enclosing item-like thing.
 560     let env_def_id = tcx.hir().get_parent_item(hir_trait.hir_ref_id);
 561     let item_cx = self::collect::ItemCtxt::new(tcx, env_def_id.to_def_id());
 562     let mut bounds = Bounds::default();
 563     let _ = <dyn AstConv<'_>>::instantiate_poly_trait_ref(
 564         &item_cx,
 565         hir_trait,
 566         DUMMY_SP,
 567         ty::BoundConstness::NotConst,
 568         self_ty,
 569         &mut bounds,
 570         true,
 571     );
 572
 573     bounds
 574 }