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