src/librustc_typeck/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/")]
  59
  60 #![allow(non_camel_case_types)]
  61
  62 #![feature(box_patterns)]
  63 #![feature(box_syntax)]
  64 #![feature(crate_visibility_modifier)]
  65 #![feature(exhaustive_patterns)]
  66 #![feature(in_band_lifetimes)]
  67 #![feature(nll)]
  68 #![feature(rustc_diagnostic_macros)]
  69 #![feature(slice_patterns)]
  70 #![feature(never_type)]
  71 #![feature(inner_deref)]
  72
  73 #![recursion_limit="256"]
  74
  75 #![deny(rust_2018_idioms)]
  76 #![deny(internal)]
  77 #![deny(unused_lifetimes)]
  78 #![allow(explicit_outlives_requirements)]
  79
  80 #[macro_use] extern crate log;
  81 #[macro_use] extern crate syntax;
  82
  83 #[macro_use] extern crate rustc;
  84
  85 // N.B., this module needs to be declared first so diagnostics are
  86 // registered before they are used.
  87 mod error_codes;
  88
  89 mod astconv;
  90 mod check;
  91 mod check_unused;
  92 mod coherence;
  93 mod collect;
  94 mod constrained_generic_params;
  95 mod structured_errors;
  96 mod impl_wf_check;
  97 mod namespace;
  98 mod outlives;
  99 mod variance;
 100
 101 use rustc_target::spec::abi::Abi;
 102 use rustc::hir::{self, Node};
 103 use rustc::hir::def_id::{DefId, LOCAL_CRATE};
 104 use rustc::infer::InferOk;
 105 use rustc::lint;
 106 use rustc::middle;
 107 use rustc::session;
 108 use rustc::util::common::ErrorReported;
 109 use rustc::session::config::{EntryFnType, nightly_options};
 110 use rustc::traits::{ObligationCause, ObligationCauseCode, TraitEngine, TraitEngineExt};
 111 use rustc::ty::subst::SubstsRef;
 112 use rustc::ty::{self, Ty, TyCtxt};
 113 use rustc::ty::query::Providers;
 114 use rustc::util;
 115 use syntax_pos::Span;
 116 use util::common::time;
 117
 118 use std::iter;
 119
 120 use astconv::{AstConv, Bounds};
 121 pub use collect::checked_type_of;
 122
 123 pub struct TypeAndSubsts<'tcx> {
 124     substs: SubstsRef<'tcx>,
 125     ty: Ty<'tcx>,
 126 }
 127
 128 fn check_type_alias_enum_variants_enabled<'tcx>(tcx: TyCtxt<'tcx>, span: Span) {
 129     if !tcx.features().type_alias_enum_variants {
 130         let mut err = tcx.sess.struct_span_err(
 131             span,
 132             "enum variants on type aliases are experimental"
 133         );
 134         if nightly_options::is_nightly_build() {
 135             help!(&mut err,
 136                 "add `#![feature(type_alias_enum_variants)]` to the \
 137                 crate attributes to enable");
 138         }
 139         err.emit();
 140     }
 141 }
 142
 143 fn require_c_abi_if_c_variadic(tcx: TyCtxt<'_>, decl: &hir::FnDecl, abi: Abi, span: Span) {
 144     if decl.c_variadic && !(abi == Abi::C || abi == Abi::Cdecl) {
 145         let mut err = struct_span_err!(tcx.sess, span, E0045,
 146             "C-variadic function must have C or cdecl calling convention");
 147         err.span_label(span, "C-variadics require C or cdecl calling convention").emit();
 148     }
 149 }
 150
 151 fn require_same_types<'tcx>(
 152     tcx: TyCtxt<'tcx>,
 153     cause: &ObligationCause<'tcx>,
 154     expected: Ty<'tcx>,
 155     actual: Ty<'tcx>,
 156 ) -> bool {
 157     tcx.infer_ctxt().enter(|ref infcx| {
 158         let param_env = ty::ParamEnv::empty();
 159         let mut fulfill_cx = TraitEngine::new(infcx.tcx);
 160         match infcx.at(&cause, param_env).eq(expected, actual) {
 161             Ok(InferOk { obligations, .. }) => {
 162                 fulfill_cx.register_predicate_obligations(infcx, obligations);
 163             }
 164             Err(err) => {
 165                 infcx.report_mismatched_types(cause, expected, actual, err).emit();
 166                 return false;
 167             }
 168         }
 169
 170         match fulfill_cx.select_all_or_error(infcx) {
 171             Ok(()) => true,
 172             Err(errors) => {
 173                 infcx.report_fulfillment_errors(&errors, None, false);
 174                 false
 175             }
 176         }
 177     })
 178 }
 179
 180 fn check_main_fn_ty<'tcx>(tcx: TyCtxt<'tcx>, main_def_id: DefId) {
 181     let main_id = tcx.hir().as_local_hir_id(main_def_id).unwrap();
 182     let main_span = tcx.def_span(main_def_id);
 183     let main_t = tcx.type_of(main_def_id);
 184     match main_t.sty {
 185         ty::FnDef(..) => {
 186             if let Some(Node::Item(it)) = tcx.hir().find_by_hir_id(main_id) {
 187                 if let hir::ItemKind::Fn(.., ref generics, _) = it.node {
 188                     let mut error = false;
 189                     if !generics.params.is_empty() {
 190                         let msg = "`main` function is not allowed to have generic \
 191                                    parameters".to_owned();
 192                         let label = "`main` cannot have generic parameters".to_string();
 193                         struct_span_err!(tcx.sess, generics.span, E0131, "{}", msg)
 194                             .span_label(generics.span, label)
 195                             .emit();
 196                         error = true;
 197                     }
 198                     if let Some(sp) = generics.where_clause.span() {
 199                         struct_span_err!(tcx.sess, sp, E0646,
 200                             "`main` function is not allowed to have a `where` clause")
 201                             .span_label(sp, "`main` cannot have a `where` clause")
 202                             .emit();
 203                         error = true;
 204                     }
 205                     if error {
 206                         return;
 207                     }
 208                 }
 209             }
 210
 211             let actual = tcx.fn_sig(main_def_id);
 212             let expected_return_type = if tcx.lang_items().termination().is_some() {
 213                 // we take the return type of the given main function, the real check is done
 214                 // in `check_fn`
 215                 actual.output().skip_binder()
 216             } else {
 217                 // standard () main return type
 218                 tcx.mk_unit()
 219             };
 220
 221             let se_ty = tcx.mk_fn_ptr(ty::Binder::bind(
 222                 tcx.mk_fn_sig(
 223                     iter::empty(),
 224                     expected_return_type,
 225                     false,
 226                     hir::Unsafety::Normal,
 227                     Abi::Rust
 228                 )
 229             ));
 230
 231             require_same_types(
 232                 tcx,
 233                 &ObligationCause::new(main_span, main_id, ObligationCauseCode::MainFunctionType),
 234                 se_ty,
 235                 tcx.mk_fn_ptr(actual));
 236         }
 237         _ => {
 238             span_bug!(main_span,
 239                       "main has a non-function type: found `{}`",
 240                       main_t);
 241         }
 242     }
 243 }
 244
 245 fn check_start_fn_ty<'tcx>(tcx: TyCtxt<'tcx>, start_def_id: DefId) {
 246     let start_id = tcx.hir().as_local_hir_id(start_def_id).unwrap();
 247     let start_span = tcx.def_span(start_def_id);
 248     let start_t = tcx.type_of(start_def_id);
 249     match start_t.sty {
 250         ty::FnDef(..) => {
 251             if let Some(Node::Item(it)) = tcx.hir().find_by_hir_id(start_id) {
 252                 if let hir::ItemKind::Fn(.., ref generics, _) = it.node {
 253                     let mut error = false;
 254                     if !generics.params.is_empty() {
 255                         struct_span_err!(tcx.sess, generics.span, E0132,
 256                             "start function is not allowed to have type parameters")
 257                             .span_label(generics.span,
 258                                         "start function cannot have type parameters")
 259                             .emit();
 260                         error = true;
 261                     }
 262                     if let Some(sp) = generics.where_clause.span() {
 263                         struct_span_err!(tcx.sess, sp, E0647,
 264                             "start function is not allowed to have a `where` clause")
 265                             .span_label(sp, "start function cannot have a `where` clause")
 266                             .emit();
 267                         error = true;
 268                     }
 269                     if error {
 270                         return;
 271                     }
 272                 }
 273             }
 274
 275             let se_ty = tcx.mk_fn_ptr(ty::Binder::bind(
 276                 tcx.mk_fn_sig(
 277                     [
 278                         tcx.types.isize,
 279                         tcx.mk_imm_ptr(tcx.mk_imm_ptr(tcx.types.u8))
 280                     ].iter().cloned(),
 281                     tcx.types.isize,
 282                     false,
 283                     hir::Unsafety::Normal,
 284                     Abi::Rust
 285                 )
 286             ));
 287
 288             require_same_types(
 289                 tcx,
 290                 &ObligationCause::new(start_span, start_id, ObligationCauseCode::StartFunctionType),
 291                 se_ty,
 292                 tcx.mk_fn_ptr(tcx.fn_sig(start_def_id)));
 293         }
 294         _ => {
 295             span_bug!(start_span,
 296                       "start has a non-function type: found `{}`",
 297                       start_t);
 298         }
 299     }
 300 }
 301
 302 fn check_for_entry_fn<'tcx>(tcx: TyCtxt<'tcx>) {
 303     match tcx.entry_fn(LOCAL_CRATE) {
 304         Some((def_id, EntryFnType::Main)) => check_main_fn_ty(tcx, def_id),
 305         Some((def_id, EntryFnType::Start)) => check_start_fn_ty(tcx, def_id),
 306         _ => {}
 307     }
 308 }
 309
 310 pub fn provide(providers: &mut Providers<'_>) {
 311     collect::provide(providers);
 312     coherence::provide(providers);
 313     check::provide(providers);
 314     variance::provide(providers);
 315     outlives::provide(providers);
 316     impl_wf_check::provide(providers);
 317 }
 318
 319 pub fn check_crate<'tcx>(tcx: TyCtxt<'tcx>) -> Result<(), ErrorReported> {
 320     tcx.sess.profiler(|p| p.start_activity("type-check crate"));
 321
 322     // this ensures that later parts of type checking can assume that items
 323     // have valid types and not error
 324     tcx.sess.track_errors(|| {
 325         time(tcx.sess, "type collecting", || {
 326             for &module in tcx.hir().krate().modules.keys() {
 327                 tcx.ensure().collect_mod_item_types(tcx.hir().local_def_id(module));
 328             }
 329         });
 330     })?;
 331
 332     if tcx.features().rustc_attrs {
 333         tcx.sess.track_errors(|| {
 334             time(tcx.sess, "outlives testing", ||
 335                 outlives::test::test_inferred_outlives(tcx));
 336         })?;
 337     }
 338
 339     tcx.sess.track_errors(|| {
 340         time(tcx.sess, "impl wf inference", ||
 341              impl_wf_check::impl_wf_check(tcx));
 342     })?;
 343
 344     tcx.sess.track_errors(|| {
 345       time(tcx.sess, "coherence checking", ||
 346           coherence::check_coherence(tcx));
 347     })?;
 348
 349     if tcx.features().rustc_attrs {
 350         tcx.sess.track_errors(|| {
 351             time(tcx.sess, "variance testing", ||
 352                 variance::test::test_variance(tcx));
 353         })?;
 354     }
 355
 356     time(tcx.sess, "wf checking", || check::check_wf_new(tcx))?;
 357
 358     time(tcx.sess, "item-types checking", || {
 359         for &module in tcx.hir().krate().modules.keys() {
 360             tcx.ensure().check_mod_item_types(tcx.hir().local_def_id(module));
 361         }
 362     });
 363
 364     time(tcx.sess, "item-bodies checking", || tcx.typeck_item_bodies(LOCAL_CRATE));
 365
 366     check_unused::check_crate(tcx);
 367     check_for_entry_fn(tcx);
 368
 369     tcx.sess.profiler(|p| p.end_activity("type-check crate"));
 370
 371     if tcx.sess.err_count() == 0 {
 372         Ok(())
 373     } else {
 374         Err(ErrorReported)
 375     }
 376 }
 377
 378 /// A quasi-deprecated helper used in rustdoc and clippy to get
 379 /// the type from a HIR node.
 380 pub fn hir_ty_to_ty<'tcx>(tcx: TyCtxt<'tcx>, hir_ty: &hir::Ty) -> Ty<'tcx> {
 381     // In case there are any projections, etc., find the "environment"
 382     // def-ID that will be used to determine the traits/predicates in
 383     // scope.  This is derived from the enclosing item-like thing.
 384     let env_node_id = tcx.hir().get_parent_item(hir_ty.hir_id);
 385     let env_def_id = tcx.hir().local_def_id_from_hir_id(env_node_id);
 386     let item_cx = self::collect::ItemCtxt::new(tcx, env_def_id);
 387
 388     astconv::AstConv::ast_ty_to_ty(&item_cx, hir_ty)
 389 }
 390
 391 pub fn hir_trait_to_predicates<'tcx>(
 392     tcx: TyCtxt<'tcx>,
 393     hir_trait: &hir::TraitRef,
 394 ) -> (ty::PolyTraitRef<'tcx>, Bounds<'tcx>) {
 395     // In case there are any projections, etc., find the "environment"
 396     // def-ID that will be used to determine the traits/predicates in
 397     // scope.  This is derived from the enclosing item-like thing.
 398     let env_hir_id = tcx.hir().get_parent_item(hir_trait.hir_ref_id);
 399     let env_def_id = tcx.hir().local_def_id_from_hir_id(env_hir_id);
 400     let item_cx = self::collect::ItemCtxt::new(tcx, env_def_id);
 401     let mut bounds = Bounds::default();
 402     let (principal, _) = AstConv::instantiate_poly_trait_ref_inner(
 403         &item_cx, hir_trait, tcx.types.err, &mut bounds, true
 404     );
 405
 406     (principal, bounds)
 407 }
 408
 409 __build_diagnostic_array! { librustc_typeck, DIAGNOSTICS }