src/librustc_mir/borrow_check/nll/type_check/mod.rs

   1 // Copyright 2016 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! This pass type-checks the MIR to ensure it is not broken.
  12 #![allow(unreachable_code)]
  13
  14 use borrow_check::borrow_set::BorrowSet;
  15 use borrow_check::location::LocationTable;
  16 use borrow_check::nll::constraints::{ConstraintSet, OutlivesConstraint};
  17 use borrow_check::nll::facts::AllFacts;
  18 use borrow_check::nll::region_infer::values::LivenessValues;
  19 use borrow_check::nll::region_infer::values::PlaceholderIndices;
  20 use borrow_check::nll::region_infer::values::RegionValueElements;
  21 use borrow_check::nll::region_infer::{ClosureRegionRequirementsExt, TypeTest};
  22 use borrow_check::nll::renumber;
  23 use borrow_check::nll::type_check::free_region_relations::{
  24     CreateResult, UniversalRegionRelations,
  25 };
  26 use borrow_check::nll::universal_regions::{DefiningTy, UniversalRegions};
  27 use borrow_check::nll::ToRegionVid;
  28 use dataflow::move_paths::MoveData;
  29 use dataflow::FlowAtLocation;
  30 use dataflow::MaybeInitializedPlaces;
  31 use rustc::hir;
  32 use rustc::hir::def_id::DefId;
  33 use rustc::infer::canonical::QueryRegionConstraint;
  34 use rustc::infer::outlives::env::RegionBoundPairs;
  35 use rustc::infer::{InferCtxt, InferOk, LateBoundRegionConversionTime};
  36 use rustc::mir::interpret::EvalErrorKind::BoundsCheck;
  37 use rustc::mir::tcx::PlaceTy;
  38 use rustc::mir::visit::{PlaceContext, Visitor};
  39 use rustc::mir::*;
  40 use rustc::traits::query::type_op;
  41 use rustc::traits::query::type_op::custom::CustomTypeOp;
  42 use rustc::traits::query::{Fallible, NoSolution};
  43 use rustc::traits::{ObligationCause, PredicateObligations};
  44 use rustc::ty::fold::TypeFoldable;
  45 use rustc::ty::subst::{Subst, Substs, UnpackedKind, UserSelfTy, UserSubsts};
  46 use rustc::ty::{self, RegionVid, ToPolyTraitRef, Ty, TyCtxt, TyKind};
  47 use std::rc::Rc;
  48 use std::{fmt, iter};
  49 use syntax_pos::{Span, DUMMY_SP};
  50 use transform::{MirPass, MirSource};
  51
  52 use either::Either;
  53 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  54
  55 macro_rules! span_mirbug {
  56     ($context:expr, $elem:expr, $($message:tt)*) => ({
  57         $crate::borrow_check::nll::type_check::mirbug(
  58             $context.tcx(),
  59             $context.last_span,
  60             &format!(
  61                 "broken MIR in {:?} ({:?}): {}",
  62                 $context.mir_def_id,
  63                 $elem,
  64                 format_args!($($message)*),
  65             ),
  66         )
  67     })
  68 }
  69
  70 macro_rules! span_mirbug_and_err {
  71     ($context:expr, $elem:expr, $($message:tt)*) => ({
  72         {
  73             span_mirbug!($context, $elem, $($message)*);
  74             $context.error()
  75         }
  76     })
  77 }
  78
  79 mod constraint_conversion;
  80 pub mod free_region_relations;
  81 mod input_output;
  82 crate mod liveness;
  83 mod relate_tys;
  84
  85 /// Type checks the given `mir` in the context of the inference
  86 /// context `infcx`. Returns any region constraints that have yet to
  87 /// be proven. This result is includes liveness constraints that
  88 /// ensure that regions appearing in the types of all local variables
  89 /// are live at all points where that local variable may later be
  90 /// used.
  91 ///
  92 /// This phase of type-check ought to be infallible -- this is because
  93 /// the original, HIR-based type-check succeeded. So if any errors
  94 /// occur here, we will get a `bug!` reported.
  95 ///
  96 /// # Parameters
  97 ///
  98 /// - `infcx` -- inference context to use
  99 /// - `param_env` -- parameter environment to use for trait solving
 100 /// - `mir` -- MIR to type-check
 101 /// - `mir_def_id` -- DefId from which the MIR is derived (must be local)
 102 /// - `region_bound_pairs` -- the implied outlives obligations between type parameters
 103 ///   and lifetimes (e.g., `&'a T` implies `T: 'a`)
 104 /// - `implicit_region_bound` -- a region which all generic parameters are assumed
 105 ///   to outlive; should represent the fn body
 106 /// - `input_tys` -- fully liberated, but **not** normalized, expected types of the arguments;
 107 ///   the types of the input parameters found in the MIR itself will be equated with these
 108 /// - `output_ty` -- fully liberated, but **not** normalized, expected return type;
 109 ///   the type for the RETURN_PLACE will be equated with this
 110 /// - `liveness` -- results of a liveness computation on the MIR; used to create liveness
 111 ///   constraints for the regions in the types of variables
 112 /// - `flow_inits` -- results of a maybe-init dataflow analysis
 113 /// - `move_data` -- move-data constructed when performing the maybe-init dataflow analysiss
 114 pub(crate) fn type_check<'gcx, 'tcx>(
 115     infcx: &InferCtxt<'_, 'gcx, 'tcx>,
 116     param_env: ty::ParamEnv<'gcx>,
 117     mir: &Mir<'tcx>,
 118     mir_def_id: DefId,
 119     universal_regions: &Rc<UniversalRegions<'tcx>>,
 120     location_table: &LocationTable,
 121     borrow_set: &BorrowSet<'tcx>,
 122     all_facts: &mut Option<AllFacts>,
 123     flow_inits: &mut FlowAtLocation<MaybeInitializedPlaces<'_, 'gcx, 'tcx>>,
 124     move_data: &MoveData<'tcx>,
 125     elements: &Rc<RegionValueElements>,
 126 ) -> MirTypeckResults<'tcx> {
 127     let implicit_region_bound = infcx.tcx.mk_region(ty::ReVar(universal_regions.fr_fn_body));
 128     let mut constraints = MirTypeckRegionConstraints {
 129         liveness_constraints: LivenessValues::new(elements),
 130         outlives_constraints: ConstraintSet::default(),
 131         closure_bounds_mapping: Default::default(),
 132         type_tests: Vec::default(),
 133     };
 134     let mut placeholder_indices = PlaceholderIndices::default();
 135
 136     let CreateResult {
 137         universal_region_relations,
 138         region_bound_pairs,
 139         normalized_inputs_and_output,
 140     } = free_region_relations::create(
 141         infcx,
 142         param_env,
 143         Some(implicit_region_bound),
 144         universal_regions,
 145         &mut constraints,
 146     );
 147
 148     let mut borrowck_context = BorrowCheckContext {
 149         universal_regions,
 150         location_table,
 151         borrow_set,
 152         all_facts,
 153         constraints: &mut constraints,
 154         placeholder_indices: &mut placeholder_indices,
 155     };
 156
 157     type_check_internal(
 158         infcx,
 159         mir_def_id,
 160         param_env,
 161         mir,
 162         &region_bound_pairs,
 163         Some(implicit_region_bound),
 164         Some(&mut borrowck_context),
 165         Some(&universal_region_relations),
 166         |cx| {
 167             cx.equate_inputs_and_outputs(mir, universal_regions, &normalized_inputs_and_output);
 168             liveness::generate(cx, mir, elements, flow_inits, move_data, location_table);
 169
 170             cx.borrowck_context
 171                 .as_mut()
 172                 .map(|bcx| translate_outlives_facts(bcx));
 173         },
 174     );
 175
 176     MirTypeckResults {
 177         constraints,
 178         placeholder_indices,
 179         universal_region_relations,
 180     }
 181 }
 182
 183 fn type_check_internal<'a, 'gcx, 'tcx, R>(
 184     infcx: &'a InferCtxt<'a, 'gcx, 'tcx>,
 185     mir_def_id: DefId,
 186     param_env: ty::ParamEnv<'gcx>,
 187     mir: &'a Mir<'tcx>,
 188     region_bound_pairs: &'a RegionBoundPairs<'tcx>,
 189     implicit_region_bound: Option<ty::Region<'tcx>>,
 190     borrowck_context: Option<&'a mut BorrowCheckContext<'a, 'tcx>>,
 191     universal_region_relations: Option<&'a UniversalRegionRelations<'tcx>>,
 192     mut extra: impl FnMut(&mut TypeChecker<'a, 'gcx, 'tcx>) -> R,
 193 ) -> R where {
 194     let mut checker = TypeChecker::new(
 195         infcx,
 196         mir,
 197         mir_def_id,
 198         param_env,
 199         region_bound_pairs,
 200         implicit_region_bound,
 201         borrowck_context,
 202         universal_region_relations,
 203     );
 204     let errors_reported = {
 205         let mut verifier = TypeVerifier::new(&mut checker, mir);
 206         verifier.visit_mir(mir);
 207         verifier.errors_reported
 208     };
 209
 210     if !errors_reported {
 211         // if verifier failed, don't do further checks to avoid ICEs
 212         checker.typeck_mir(mir);
 213     }
 214
 215     extra(&mut checker)
 216 }
 217
 218 fn translate_outlives_facts(cx: &mut BorrowCheckContext) {
 219     if let Some(facts) = cx.all_facts {
 220         let location_table = cx.location_table;
 221         facts
 222             .outlives
 223             .extend(cx.constraints.outlives_constraints.iter().flat_map(
 224                 |constraint: &OutlivesConstraint| {
 225                     if let Some(from_location) = constraint.locations.from_location() {
 226                         Either::Left(iter::once((
 227                             constraint.sup,
 228                             constraint.sub,
 229                             location_table.mid_index(from_location),
 230                         )))
 231                     } else {
 232                         Either::Right(
 233                             location_table
 234                                 .all_points()
 235                                 .map(move |location| (constraint.sup, constraint.sub, location)),
 236                         )
 237                     }
 238                 },
 239             ));
 240     }
 241 }
 242
 243 fn mirbug(tcx: TyCtxt, span: Span, msg: &str) {
 244     // We sometimes see MIR failures (notably predicate failures) due to
 245     // the fact that we check rvalue sized predicates here. So use `delay_span_bug`
 246     // to avoid reporting bugs in those cases.
 247     tcx.sess.diagnostic().delay_span_bug(span, msg);
 248 }
 249
 250 enum FieldAccessError {
 251     OutOfRange { field_count: usize },
 252 }
 253
 254 /// Verifies that MIR types are sane to not crash further checks.
 255 ///
 256 /// The sanitize_XYZ methods here take an MIR object and compute its
 257 /// type, calling `span_mirbug` and returning an error type if there
 258 /// is a problem.
 259 struct TypeVerifier<'a, 'b: 'a, 'gcx: 'tcx, 'tcx: 'b> {
 260     cx: &'a mut TypeChecker<'b, 'gcx, 'tcx>,
 261     mir: &'a Mir<'tcx>,
 262     last_span: Span,
 263     mir_def_id: DefId,
 264     errors_reported: bool,
 265 }
 266
 267 impl<'a, 'b, 'gcx, 'tcx> Visitor<'tcx> for TypeVerifier<'a, 'b, 'gcx, 'tcx> {
 268     fn visit_span(&mut self, span: &Span) {
 269         if !span.is_dummy() {
 270             self.last_span = *span;
 271         }
 272     }
 273
 274     fn visit_place(&mut self, place: &Place<'tcx>, context: PlaceContext, location: Location) {
 275         self.sanitize_place(place, location, context);
 276     }
 277
 278     fn visit_constant(&mut self, constant: &Constant<'tcx>, location: Location) {
 279         self.super_constant(constant, location);
 280         self.sanitize_constant(constant, location);
 281         self.sanitize_type(constant, constant.ty);
 282
 283         if let Some(user_ty) = constant.user_ty {
 284             if let Err(terr) = self.cx.relate_type_and_user_type(
 285                 constant.ty,
 286                 ty::Variance::Invariant,
 287                 user_ty,
 288                 location.to_locations(),
 289                 ConstraintCategory::Boring,
 290             ) {
 291                 span_mirbug!(
 292                     self,
 293                     constant,
 294                     "bad constant user type {:?} vs {:?}: {:?}",
 295                     user_ty,
 296                     constant.ty,
 297                     terr,
 298                 );
 299             }
 300         }
 301     }
 302
 303     fn visit_rvalue(&mut self, rvalue: &Rvalue<'tcx>, location: Location) {
 304         self.super_rvalue(rvalue, location);
 305         let rval_ty = rvalue.ty(self.mir, self.tcx());
 306         self.sanitize_type(rvalue, rval_ty);
 307     }
 308
 309     fn visit_local_decl(&mut self, local: Local, local_decl: &LocalDecl<'tcx>) {
 310         self.super_local_decl(local, local_decl);
 311         self.sanitize_type(local_decl, local_decl.ty);
 312
 313         if let Some((user_ty, span)) = local_decl.user_ty {
 314             if let Err(terr) = self.cx.relate_type_and_user_type(
 315                 local_decl.ty,
 316                 ty::Variance::Invariant,
 317                 user_ty,
 318                 Locations::All(span),
 319                 ConstraintCategory::TypeAnnotation,
 320             ) {
 321                 span_mirbug!(
 322                     self,
 323                     local,
 324                     "bad user type on variable {:?}: {:?} != {:?} ({:?})",
 325                     local,
 326                     local_decl.ty,
 327                     local_decl.user_ty,
 328                     terr,
 329                 );
 330             }
 331         }
 332     }
 333
 334     fn visit_mir(&mut self, mir: &Mir<'tcx>) {
 335         self.sanitize_type(&"return type", mir.return_ty());
 336         for local_decl in &mir.local_decls {
 337             self.sanitize_type(local_decl, local_decl.ty);
 338         }
 339         if self.errors_reported {
 340             return;
 341         }
 342         self.super_mir(mir);
 343     }
 344 }
 345
 346 impl<'a, 'b, 'gcx, 'tcx> TypeVerifier<'a, 'b, 'gcx, 'tcx> {
 347     fn new(cx: &'a mut TypeChecker<'b, 'gcx, 'tcx>, mir: &'a Mir<'tcx>) -> Self {
 348         TypeVerifier {
 349             mir,
 350             mir_def_id: cx.mir_def_id,
 351             cx,
 352             last_span: mir.span,
 353             errors_reported: false,
 354         }
 355     }
 356
 357     fn tcx(&self) -> TyCtxt<'a, 'gcx, 'tcx> {
 358         self.cx.infcx.tcx
 359     }
 360
 361     fn sanitize_type(&mut self, parent: &dyn fmt::Debug, ty: Ty<'tcx>) -> Ty<'tcx> {
 362         if ty.has_escaping_regions() || ty.references_error() {
 363             span_mirbug_and_err!(self, parent, "bad type {:?}", ty)
 364         } else {
 365             ty
 366         }
 367     }
 368
 369     /// Checks that the constant's `ty` field matches up with what
 370     /// would be expected from its literal.
 371     fn sanitize_constant(&mut self, constant: &Constant<'tcx>, location: Location) {
 372         debug!(
 373             "sanitize_constant(constant={:?}, location={:?})",
 374             constant, location
 375         );
 376
 377         // FIXME(#46702) -- We need some way to get the predicates
 378         // associated with the "pre-evaluated" form of the
 379         // constant. For example, consider that the constant
 380         // may have associated constant projections (`<Foo as
 381         // Trait<'a, 'b>>::SOME_CONST`) that impose
 382         // constraints on `'a` and `'b`. These constraints
 383         // would be lost if we just look at the normalized
 384         // value.
 385         if let ty::FnDef(def_id, substs) = constant.literal.ty.sty {
 386             let tcx = self.tcx();
 387             let type_checker = &mut self.cx;
 388
 389             // FIXME -- For now, use the substitutions from
 390             // `value.ty` rather than `value.val`. The
 391             // renumberer will rewrite them to independent
 392             // sets of regions; in principle, we ought to
 393             // derive the type of the `value.val` from "first
 394             // principles" and equate with value.ty, but as we
 395             // are transitioning to the miri-based system, we
 396             // don't have a handy function for that, so for
 397             // now we just ignore `value.val` regions.
 398
 399             let instantiated_predicates = tcx.predicates_of(def_id).instantiate(tcx, substs);
 400             type_checker.normalize_and_prove_instantiated_predicates(
 401                 instantiated_predicates,
 402                 location.to_locations(),
 403             );
 404         }
 405
 406         debug!("sanitize_constant: expected_ty={:?}", constant.literal.ty);
 407
 408         if let Err(terr) = self.cx.eq_types(
 409             constant.literal.ty,
 410             constant.ty,
 411             location.to_locations(),
 412             ConstraintCategory::Boring,
 413         ) {
 414             span_mirbug!(
 415                 self,
 416                 constant,
 417                 "constant {:?} should have type {:?} but has {:?} ({:?})",
 418                 constant,
 419                 constant.literal.ty,
 420                 constant.ty,
 421                 terr,
 422             );
 423         }
 424     }
 425
 426     /// Checks that the types internal to the `place` match up with
 427     /// what would be expected.
 428     fn sanitize_place(
 429         &mut self,
 430         place: &Place<'tcx>,
 431         location: Location,
 432         context: PlaceContext,
 433     ) -> PlaceTy<'tcx> {
 434         debug!("sanitize_place: {:?}", place);
 435         let place_ty = match *place {
 436             Place::Local(index) => PlaceTy::Ty {
 437                 ty: self.mir.local_decls[index].ty,
 438             },
 439             Place::Promoted(box (_index, sty)) => {
 440                 let sty = self.sanitize_type(place, sty);
 441                 // FIXME -- promoted MIR return types reference
 442                 // various "free regions" (e.g., scopes and things)
 443                 // that they ought not to do. We have to figure out
 444                 // how best to handle that -- probably we want treat
 445                 // promoted MIR much like closures, renumbering all
 446                 // their free regions and propagating constraints
 447                 // upwards. We have the same acyclic guarantees, so
 448                 // that should be possible. But for now, ignore them.
 449                 //
 450                 // let promoted_mir = &self.mir.promoted[index];
 451                 // promoted_mir.return_ty()
 452                 PlaceTy::Ty { ty: sty }
 453             }
 454             Place::Static(box Static { def_id, ty: sty }) => {
 455                 let sty = self.sanitize_type(place, sty);
 456                 let ty = self.tcx().type_of(def_id);
 457                 let ty = self.cx.normalize(ty, location);
 458                 if let Err(terr) =
 459                     self.cx
 460                         .eq_types(ty, sty, location.to_locations(), ConstraintCategory::Boring)
 461                 {
 462                     span_mirbug!(
 463                         self,
 464                         place,
 465                         "bad static type ({:?}: {:?}): {:?}",
 466                         ty,
 467                         sty,
 468                         terr
 469                     );
 470                 }
 471                 PlaceTy::Ty { ty: sty }
 472             }
 473             Place::Projection(ref proj) => {
 474                 let base_context = if context.is_mutating_use() {
 475                     PlaceContext::Projection(Mutability::Mut)
 476                 } else {
 477                     PlaceContext::Projection(Mutability::Not)
 478                 };
 479                 let base_ty = self.sanitize_place(&proj.base, location, base_context);
 480                 if let PlaceTy::Ty { ty } = base_ty {
 481                     if ty.references_error() {
 482                         assert!(self.errors_reported);
 483                         return PlaceTy::Ty {
 484                             ty: self.tcx().types.err,
 485                         };
 486                     }
 487                 }
 488                 self.sanitize_projection(base_ty, &proj.elem, place, location)
 489             }
 490         };
 491         if let PlaceContext::Copy = context {
 492             let tcx = self.tcx();
 493             let trait_ref = ty::TraitRef {
 494                 def_id: tcx.lang_items().copy_trait().unwrap(),
 495                 substs: tcx.mk_substs_trait(place_ty.to_ty(tcx), &[]),
 496             };
 497
 498             // In order to have a Copy operand, the type T of the value must be Copy. Note that we
 499             // prove that T: Copy, rather than using the type_moves_by_default test. This is
 500             // important because type_moves_by_default ignores the resulting region obligations and
 501             // assumes they pass. This can result in bounds from Copy impls being unsoundly ignored
 502             // (e.g., #29149). Note that we decide to use Copy before knowing whether the bounds
 503             // fully apply: in effect, the rule is that if a value of some type could implement
 504             // Copy, then it must.
 505             self.cx.prove_trait_ref(
 506                 trait_ref,
 507                 location.to_locations(),
 508                 ConstraintCategory::CopyBound,
 509             );
 510         }
 511         place_ty
 512     }
 513
 514     fn sanitize_projection(
 515         &mut self,
 516         base: PlaceTy<'tcx>,
 517         pi: &PlaceElem<'tcx>,
 518         place: &Place<'tcx>,
 519         location: Location,
 520     ) -> PlaceTy<'tcx> {
 521         debug!("sanitize_projection: {:?} {:?} {:?}", base, pi, place);
 522         let tcx = self.tcx();
 523         let base_ty = base.to_ty(tcx);
 524         match *pi {
 525             ProjectionElem::Deref => {
 526                 let deref_ty = base_ty.builtin_deref(true);
 527                 PlaceTy::Ty {
 528                     ty: deref_ty.map(|t| t.ty).unwrap_or_else(|| {
 529                         span_mirbug_and_err!(self, place, "deref of non-pointer {:?}", base_ty)
 530                     }),
 531                 }
 532             }
 533             ProjectionElem::Index(i) => {
 534                 let index_ty = Place::Local(i).ty(self.mir, tcx).to_ty(tcx);
 535                 if index_ty != tcx.types.usize {
 536                     PlaceTy::Ty {
 537                         ty: span_mirbug_and_err!(self, i, "index by non-usize {:?}", i),
 538                     }
 539                 } else {
 540                     PlaceTy::Ty {
 541                         ty: base_ty.builtin_index().unwrap_or_else(|| {
 542                             span_mirbug_and_err!(self, place, "index of non-array {:?}", base_ty)
 543                         }),
 544                     }
 545                 }
 546             }
 547             ProjectionElem::ConstantIndex { .. } => {
 548                 // consider verifying in-bounds
 549                 PlaceTy::Ty {
 550                     ty: base_ty.builtin_index().unwrap_or_else(|| {
 551                         span_mirbug_and_err!(self, place, "index of non-array {:?}", base_ty)
 552                     }),
 553                 }
 554             }
 555             ProjectionElem::Subslice { from, to } => PlaceTy::Ty {
 556                 ty: match base_ty.sty {
 557                     ty::Array(inner, size) => {
 558                         let size = size.unwrap_usize(tcx);
 559                         let min_size = (from as u64) + (to as u64);
 560                         if let Some(rest_size) = size.checked_sub(min_size) {
 561                             tcx.mk_array(inner, rest_size)
 562                         } else {
 563                             span_mirbug_and_err!(
 564                                 self,
 565                                 place,
 566                                 "taking too-small slice of {:?}",
 567                                 base_ty
 568                             )
 569                         }
 570                     }
 571                     ty::Slice(..) => base_ty,
 572                     _ => span_mirbug_and_err!(self, place, "slice of non-array {:?}", base_ty),
 573                 },
 574             },
 575             ProjectionElem::Downcast(adt_def1, index) => match base_ty.sty {
 576                 ty::Adt(adt_def, substs) if adt_def.is_enum() && adt_def == adt_def1 => {
 577                     if index >= adt_def.variants.len() {
 578                         PlaceTy::Ty {
 579                             ty: span_mirbug_and_err!(
 580                                 self,
 581                                 place,
 582                                 "cast to variant #{:?} but enum only has {:?}",
 583                                 index,
 584                                 adt_def.variants.len()
 585                             ),
 586                         }
 587                     } else {
 588                         PlaceTy::Downcast {
 589                             adt_def,
 590                             substs,
 591                             variant_index: index,
 592                         }
 593                     }
 594                 }
 595                 _ => PlaceTy::Ty {
 596                     ty: span_mirbug_and_err!(
 597                         self,
 598                         place,
 599                         "can't downcast {:?} as {:?}",
 600                         base_ty,
 601                         adt_def1
 602                     ),
 603                 },
 604             },
 605             ProjectionElem::Field(field, fty) => {
 606                 let fty = self.sanitize_type(place, fty);
 607                 match self.field_ty(place, base, field, location) {
 608                     Ok(ty) => if let Err(terr) = self.cx.eq_types(
 609                         ty,
 610                         fty,
 611                         location.to_locations(),
 612                         ConstraintCategory::Boring,
 613                     ) {
 614                         span_mirbug!(
 615                             self,
 616                             place,
 617                             "bad field access ({:?}: {:?}): {:?}",
 618                             ty,
 619                             fty,
 620                             terr
 621                         );
 622                     },
 623                     Err(FieldAccessError::OutOfRange { field_count }) => span_mirbug!(
 624                         self,
 625                         place,
 626                         "accessed field #{} but variant only has {}",
 627                         field.index(),
 628                         field_count
 629                     ),
 630                 }
 631                 PlaceTy::Ty { ty: fty }
 632             }
 633         }
 634     }
 635
 636     fn error(&mut self) -> Ty<'tcx> {
 637         self.errors_reported = true;
 638         self.tcx().types.err
 639     }
 640
 641     fn field_ty(
 642         &mut self,
 643         parent: &dyn fmt::Debug,
 644         base_ty: PlaceTy<'tcx>,
 645         field: Field,
 646         location: Location,
 647     ) -> Result<Ty<'tcx>, FieldAccessError> {
 648         let tcx = self.tcx();
 649
 650         let (variant, substs) = match base_ty {
 651             PlaceTy::Downcast {
 652                 adt_def,
 653                 substs,
 654                 variant_index,
 655             } => (&adt_def.variants[variant_index], substs),
 656             PlaceTy::Ty { ty } => match ty.sty {
 657                 ty::Adt(adt_def, substs) if !adt_def.is_enum() => (&adt_def.variants[0], substs),
 658                 ty::Closure(def_id, substs) => {
 659                     return match substs.upvar_tys(def_id, tcx).nth(field.index()) {
 660                         Some(ty) => Ok(ty),
 661                         None => Err(FieldAccessError::OutOfRange {
 662                             field_count: substs.upvar_tys(def_id, tcx).count(),
 663                         }),
 664                     }
 665                 }
 666                 ty::Generator(def_id, substs, _) => {
 667                     // Try pre-transform fields first (upvars and current state)
 668                     if let Some(ty) = substs.pre_transforms_tys(def_id, tcx).nth(field.index()) {
 669                         return Ok(ty);
 670                     }
 671
 672                     // Then try `field_tys` which contains all the fields, but it
 673                     // requires the final optimized MIR.
 674                     return match substs.field_tys(def_id, tcx).nth(field.index()) {
 675                         Some(ty) => Ok(ty),
 676                         None => Err(FieldAccessError::OutOfRange {
 677                             field_count: substs.field_tys(def_id, tcx).count(),
 678                         }),
 679                     };
 680                 }
 681                 ty::Tuple(tys) => {
 682                     return match tys.get(field.index()) {
 683                         Some(&ty) => Ok(ty),
 684                         None => Err(FieldAccessError::OutOfRange {
 685                             field_count: tys.len(),
 686                         }),
 687                     }
 688                 }
 689                 _ => {
 690                     return Ok(span_mirbug_and_err!(
 691                         self,
 692                         parent,
 693                         "can't project out of {:?}",
 694                         base_ty
 695                     ))
 696                 }
 697             },
 698         };
 699
 700         if let Some(field) = variant.fields.get(field.index()) {
 701             Ok(self.cx.normalize(&field.ty(tcx, substs), location))
 702         } else {
 703             Err(FieldAccessError::OutOfRange {
 704                 field_count: variant.fields.len(),
 705             })
 706         }
 707     }
 708 }
 709
 710 /// The MIR type checker. Visits the MIR and enforces all the
 711 /// constraints needed for it to be valid and well-typed. Along the
 712 /// way, it accrues region constraints -- these can later be used by
 713 /// NLL region checking.
 714 struct TypeChecker<'a, 'gcx: 'tcx, 'tcx: 'a> {
 715     infcx: &'a InferCtxt<'a, 'gcx, 'tcx>,
 716     param_env: ty::ParamEnv<'gcx>,
 717     last_span: Span,
 718     mir: &'a Mir<'tcx>,
 719     mir_def_id: DefId,
 720     region_bound_pairs: &'a RegionBoundPairs<'tcx>,
 721     implicit_region_bound: Option<ty::Region<'tcx>>,
 722     reported_errors: FxHashSet<(Ty<'tcx>, Span)>,
 723     borrowck_context: Option<&'a mut BorrowCheckContext<'a, 'tcx>>,
 724     universal_region_relations: Option<&'a UniversalRegionRelations<'tcx>>,
 725 }
 726
 727 struct BorrowCheckContext<'a, 'tcx: 'a> {
 728     universal_regions: &'a UniversalRegions<'tcx>,
 729     location_table: &'a LocationTable,
 730     all_facts: &'a mut Option<AllFacts>,
 731     borrow_set: &'a BorrowSet<'tcx>,
 732     constraints: &'a mut MirTypeckRegionConstraints<'tcx>,
 733     placeholder_indices: &'a mut PlaceholderIndices,
 734 }
 735
 736 crate struct MirTypeckResults<'tcx> {
 737     crate constraints: MirTypeckRegionConstraints<'tcx>,
 738     crate placeholder_indices: PlaceholderIndices,
 739     crate universal_region_relations: Rc<UniversalRegionRelations<'tcx>>,
 740 }
 741
 742 /// A collection of region constraints that must be satisfied for the
 743 /// program to be considered well-typed.
 744 crate struct MirTypeckRegionConstraints<'tcx> {
 745     /// In general, the type-checker is not responsible for enforcing
 746     /// liveness constraints; this job falls to the region inferencer,
 747     /// which performs a liveness analysis. However, in some limited
 748     /// cases, the MIR type-checker creates temporary regions that do
 749     /// not otherwise appear in the MIR -- in particular, the
 750     /// late-bound regions that it instantiates at call-sites -- and
 751     /// hence it must report on their liveness constraints.
 752     crate liveness_constraints: LivenessValues<RegionVid>,
 753
 754     crate outlives_constraints: ConstraintSet,
 755
 756     crate closure_bounds_mapping:
 757         FxHashMap<Location, FxHashMap<(RegionVid, RegionVid), (ConstraintCategory, Span)>>,
 758
 759     crate type_tests: Vec<TypeTest<'tcx>>,
 760 }
 761
 762 /// The `Locations` type summarizes *where* region constraints are
 763 /// required to hold. Normally, this is at a particular point which
 764 /// created the obligation, but for constraints that the user gave, we
 765 /// want the constraint to hold at all points.
 766 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
 767 pub enum Locations {
 768     /// Indicates that a type constraint should always be true. This
 769     /// is particularly important in the new borrowck analysis for
 770     /// things like the type of the return slot. Consider this
 771     /// example:
 772     ///
 773     /// ```
 774     /// fn foo<'a>(x: &'a u32) -> &'a u32 {
 775     ///     let y = 22;
 776     ///     return &y; // error
 777     /// }
 778     /// ```
 779     ///
 780     /// Here, we wind up with the signature from the return type being
 781     /// something like `&'1 u32` where `'1` is a universal region. But
 782     /// the type of the return slot `_0` is something like `&'2 u32`
 783     /// where `'2` is an existential region variable. The type checker
 784     /// requires that `&'2 u32 = &'1 u32` -- but at what point? In the
 785     /// older NLL analysis, we required this only at the entry point
 786     /// to the function. By the nature of the constraints, this wound
 787     /// up propagating to all points reachable from start (because
 788     /// `'1` -- as a universal region -- is live everywhere).  In the
 789     /// newer analysis, though, this doesn't work: `_0` is considered
 790     /// dead at the start (it has no usable value) and hence this type
 791     /// equality is basically a no-op. Then, later on, when we do `_0
 792     /// = &'3 y`, that region `'3` never winds up related to the
 793     /// universal region `'1` and hence no error occurs. Therefore, we
 794     /// use Locations::All instead, which ensures that the `'1` and
 795     /// `'2` are equal everything. We also use this for other
 796     /// user-given type annotations; e.g., if the user wrote `let mut
 797     /// x: &'static u32 = ...`, we would ensure that all values
 798     /// assigned to `x` are of `'static` lifetime.
 799     ///
 800     /// The span points to the place the constraint arose. For example,
 801     /// it points to the type in a user-given type annotation. If
 802     /// there's no sensible span then it's DUMMY_SP.
 803     All(Span),
 804
 805     /// An outlives constraint that only has to hold at a single location,
 806     /// usually it represents a point where references flow from one spot to
 807     /// another (e.g., `x = y`)
 808     Single(Location),
 809 }
 810
 811 impl Locations {
 812     pub fn from_location(&self) -> Option<Location> {
 813         match self {
 814             Locations::All(_) => None,
 815             Locations::Single(from_location) => Some(*from_location),
 816         }
 817     }
 818
 819     /// Gets a span representing the location.
 820     pub fn span(&self, mir: &Mir<'_>) -> Span {
 821         match self {
 822             Locations::All(span) => *span,
 823             Locations::Single(l) => mir.source_info(*l).span,
 824         }
 825     }
 826 }
 827
 828 impl<'a, 'gcx, 'tcx> TypeChecker<'a, 'gcx, 'tcx> {
 829     fn new(
 830         infcx: &'a InferCtxt<'a, 'gcx, 'tcx>,
 831         mir: &'a Mir<'tcx>,
 832         mir_def_id: DefId,
 833         param_env: ty::ParamEnv<'gcx>,
 834         region_bound_pairs: &'a RegionBoundPairs<'tcx>,
 835         implicit_region_bound: Option<ty::Region<'tcx>>,
 836         borrowck_context: Option<&'a mut BorrowCheckContext<'a, 'tcx>>,
 837         universal_region_relations: Option<&'a UniversalRegionRelations<'tcx>>,
 838     ) -> Self {
 839         TypeChecker {
 840             infcx,
 841             last_span: DUMMY_SP,
 842             mir,
 843             mir_def_id,
 844             param_env,
 845             region_bound_pairs,
 846             implicit_region_bound,
 847             borrowck_context,
 848             reported_errors: Default::default(),
 849             universal_region_relations,
 850         }
 851     }
 852
 853     /// Given some operation `op` that manipulates types, proves
 854     /// predicates, or otherwise uses the inference context, executes
 855     /// `op` and then executes all the further obligations that `op`
 856     /// returns. This will yield a set of outlives constraints amongst
 857     /// regions which are extracted and stored as having occurred at
 858     /// `locations`.
 859     ///
 860     /// **Any `rustc::infer` operations that might generate region
 861     /// constraints should occur within this method so that those
 862     /// constraints can be properly localized!**
 863     fn fully_perform_op<R>(
 864         &mut self,
 865         locations: Locations,
 866         category: ConstraintCategory,
 867         op: impl type_op::TypeOp<'gcx, 'tcx, Output = R>,
 868     ) -> Fallible<R> {
 869         let (r, opt_data) = op.fully_perform(self.infcx)?;
 870
 871         if let Some(data) = &opt_data {
 872             self.push_region_constraints(locations, category, data);
 873         }
 874
 875         Ok(r)
 876     }
 877
 878     fn push_region_constraints(
 879         &mut self,
 880         locations: Locations,
 881         category: ConstraintCategory,
 882         data: &[QueryRegionConstraint<'tcx>],
 883     ) {
 884         debug!(
 885             "push_region_constraints: constraints generated at {:?} are {:#?}",
 886             locations, data
 887         );
 888
 889         if let Some(ref mut borrowck_context) = self.borrowck_context {
 890             constraint_conversion::ConstraintConversion::new(
 891                 self.infcx.tcx,
 892                 borrowck_context.universal_regions,
 893                 self.region_bound_pairs,
 894                 self.implicit_region_bound,
 895                 self.param_env,
 896                 locations,
 897                 category,
 898                 &mut borrowck_context.constraints.outlives_constraints,
 899                 &mut borrowck_context.constraints.type_tests,
 900             ).convert_all(&data);
 901         }
 902     }
 903
 904     /// Convenient wrapper around `relate_tys::relate_types` -- see
 905     /// that fn for docs.
 906     fn relate_types(
 907         &mut self,
 908         a: Ty<'tcx>,
 909         v: ty::Variance,
 910         b: Ty<'tcx>,
 911         locations: Locations,
 912         category: ConstraintCategory,
 913     ) -> Fallible<()> {
 914         relate_tys::relate_types(
 915             self.infcx,
 916             a,
 917             v,
 918             b,
 919             locations,
 920             category,
 921             self.borrowck_context.as_mut().map(|x| &mut **x),
 922         )
 923     }
 924
 925     fn sub_types(
 926         &mut self,
 927         sub: Ty<'tcx>,
 928         sup: Ty<'tcx>,
 929         locations: Locations,
 930         category: ConstraintCategory,
 931     ) -> Fallible<()> {
 932         self.relate_types(sub, ty::Variance::Covariant, sup, locations, category)
 933     }
 934
 935     /// Try to relate `sub <: sup`; if this fails, instantiate opaque
 936     /// variables in `sub` with their inferred definitions and try
 937     /// again. This is used for opaque types in places (e.g., `let x:
 938     /// impl Foo = ..`).
 939     fn sub_types_or_anon(
 940         &mut self,
 941         sub: Ty<'tcx>,
 942         sup: Ty<'tcx>,
 943         locations: Locations,
 944         category: ConstraintCategory,
 945     ) -> Fallible<()> {
 946         if let Err(terr) = self.sub_types(sub, sup, locations, category) {
 947             if let TyKind::Opaque(..) = sup.sty {
 948                 // When you have `let x: impl Foo = ...` in a closure,
 949                 // the resulting inferend values are stored with the
 950                 // def-id of the base function.
 951                 let parent_def_id = self.tcx().closure_base_def_id(self.mir_def_id);
 952                 return self.eq_opaque_type_and_type(sub, sup, parent_def_id, locations, category);
 953             } else {
 954                 return Err(terr);
 955             }
 956         }
 957         Ok(())
 958     }
 959
 960     fn eq_types(
 961         &mut self,
 962         a: Ty<'tcx>,
 963         b: Ty<'tcx>,
 964         locations: Locations,
 965         category: ConstraintCategory,
 966     ) -> Fallible<()> {
 967         self.relate_types(a, ty::Variance::Invariant, b, locations, category)
 968     }
 969
 970     fn relate_type_and_user_type(
 971         &mut self,
 972         a: Ty<'tcx>,
 973         v: ty::Variance,
 974         user_ty: UserTypeAnnotation<'tcx>,
 975         locations: Locations,
 976         category: ConstraintCategory,
 977     ) -> Fallible<()> {
 978         let tcx = self.tcx();
 979
 980         debug!(
 981             "relate_type_and_user_type(a={:?}, v={:?}, b={:?}, locations={:?})",
 982             a, v, user_ty, locations
 983         );
 984
 985         // The `TypeRelating` code assumes that "unresolved inference
 986         // variables" appear in the "a" side, so flip `Contravariant`
 987         // ambient variance to get the right relationship.
 988         let v1 = ty::Contravariant.xform(v);
 989
 990         match user_ty {
 991             UserTypeAnnotation::Ty(canonical_ty) => {
 992                 let (ty, _) = self.infcx
 993                     .instantiate_canonical_with_fresh_inference_vars(DUMMY_SP, &canonical_ty);
 994
 995                 self.relate_types(ty, v1, a, locations, category)?;
 996
 997                 self.prove_predicate(ty::Predicate::WellFormed(ty), locations, category);
 998             }
 999             UserTypeAnnotation::TypeOf(def_id, canonical_substs) => {
1000                 let (
1001                     UserSubsts {
1002                         substs,
1003                         user_self_ty,
1004                     },
1005                     _,
1006                 ) = self.infcx
1007                     .instantiate_canonical_with_fresh_inference_vars(DUMMY_SP, &canonical_substs);
1008
1009                 let ty = self.tcx().type_of(def_id);
1010                 let ty = ty.subst(tcx, substs);
1011                 debug!("relate_type_and_user_type: ty of def-id is {:?}", ty);
1012                 let ty = self.normalize(ty, locations);
1013
1014                 self.relate_types(ty, v1, a, locations, category)?;
1015
1016                 if let Some(UserSelfTy {
1017                     impl_def_id,
1018                     self_ty,
1019                 }) = user_self_ty
1020                 {
1021                     let impl_self_ty = tcx.type_of(impl_def_id);
1022                     let impl_self_ty = impl_self_ty.subst(tcx, &substs);
1023                     let impl_self_ty = self.normalize(impl_self_ty, locations);
1024
1025                     // There may be type variables in `substs` and hence
1026                     // in `impl_self_ty`, but they should all have been
1027                     // resolved to some fixed value during the first call
1028                     // to `relate`, above. Therefore, if we use
1029                     // `resolve_type_vars_if_possible` we should get to
1030                     // something without type variables. This is important
1031                     // because the `b` type in `relate_with_variance`
1032                     // below is not permitted to have inference variables.
1033                     let impl_self_ty = self.infcx.resolve_type_vars_if_possible(&impl_self_ty);
1034                     assert!(!impl_self_ty.has_infer_types());
1035
1036                     self.eq_types(self_ty, impl_self_ty, locations, category)?;
1037
1038                     self.prove_predicate(
1039                         ty::Predicate::WellFormed(impl_self_ty),
1040                         locations,
1041                         category,
1042                     );
1043                 }
1044
1045                 // Prove the predicates coming along with `def_id`.
1046                 //
1047                 // Also, normalize the `instantiated_predicates`
1048                 // because otherwise we wind up with duplicate "type
1049                 // outlives" error messages.
1050                 let instantiated_predicates = tcx.predicates_of(def_id).instantiate(tcx, substs);
1051                 let instantiated_predicates = self.fold_to_region_vid(instantiated_predicates);
1052                 self.normalize_and_prove_instantiated_predicates(
1053                     instantiated_predicates,
1054                     locations,
1055                 );
1056
1057                 // In addition to proving the predicates, we have to
1058                 // prove that `ty` is well-formed -- this is because
1059                 // the WF of `ty` is predicated on the substs being
1060                 // well-formed, and we haven't proven *that*. We don't
1061                 // want to prove the WF of types from  `substs` directly because they
1062                 // haven't been normalized.
1063                 //
1064                 // FIXME(nmatsakis): Well, perhaps we should normalize
1065                 // them?  This would only be relevant if some input
1066                 // type were ill-formed but did not appear in `ty`,
1067                 // which...could happen with normalization...
1068                 self.prove_predicate(ty::Predicate::WellFormed(ty), locations, category);
1069             }
1070         }
1071
1072         Ok(())
1073     }
1074
1075     /// Replace all free regions in `value` with their NLL `RegionVid`
1076     /// equivalents; if not in NLL, does nothing. This is never
1077     /// particularly necessary -- we'll do it lazilly as we process
1078     /// the value anyway -- but in some specific cases it is useful to
1079     /// normalize so we can suppress duplicate error messages.
1080     fn fold_to_region_vid<T>(&self, value: T) -> T
1081     where
1082         T: TypeFoldable<'tcx>,
1083     {
1084         if let Some(borrowck_context) = &self.borrowck_context {
1085             self.tcx().fold_regions(&value, &mut false, |r, _debruijn| {
1086                 if r.has_free_regions() {
1087                     self.tcx().mk_region(ty::RegionKind::ReVar(
1088                         borrowck_context.universal_regions.to_region_vid(r),
1089                     ))
1090                 } else {
1091                     r
1092                 }
1093             })
1094         } else {
1095             value
1096         }
1097     }
1098
1099     fn eq_opaque_type_and_type(
1100         &mut self,
1101         revealed_ty: Ty<'tcx>,
1102         anon_ty: Ty<'tcx>,
1103         anon_owner_def_id: DefId,
1104         locations: Locations,
1105         category: ConstraintCategory,
1106     ) -> Fallible<()> {
1107         debug!(
1108             "eq_opaque_type_and_type( \
1109              revealed_ty={:?}, \
1110              anon_ty={:?})",
1111             revealed_ty, anon_ty
1112         );
1113         let infcx = self.infcx;
1114         let tcx = infcx.tcx;
1115         let param_env = self.param_env;
1116         debug!("eq_opaque_type_and_type: mir_def_id={:?}", self.mir_def_id);
1117         let opaque_type_map = self.fully_perform_op(
1118             locations,
1119             category,
1120             CustomTypeOp::new(
1121                 |infcx| {
1122                     let mut obligations = ObligationAccumulator::default();
1123
1124                     let dummy_body_id = ObligationCause::dummy().body_id;
1125                     let (output_ty, opaque_type_map) =
1126                         obligations.add(infcx.instantiate_opaque_types(
1127                             anon_owner_def_id,
1128                             dummy_body_id,
1129                             param_env,
1130                             &anon_ty,
1131                         ));
1132                     debug!(
1133                         "eq_opaque_type_and_type: \
1134                          instantiated output_ty={:?} \
1135                          opaque_type_map={:#?} \
1136                          revealed_ty={:?}",
1137                         output_ty, opaque_type_map, revealed_ty
1138                     );
1139                     obligations.add(infcx
1140                         .at(&ObligationCause::dummy(), param_env)
1141                         .eq(output_ty, revealed_ty)?);
1142
1143                     for (&opaque_def_id, opaque_decl) in &opaque_type_map {
1144                         let opaque_defn_ty = tcx.type_of(opaque_def_id);
1145                         let opaque_defn_ty = opaque_defn_ty.subst(tcx, opaque_decl.substs);
1146                         let opaque_defn_ty = renumber::renumber_regions(infcx, &opaque_defn_ty);
1147                         debug!(
1148                             "eq_opaque_type_and_type: concrete_ty={:?}={:?} opaque_defn_ty={:?}",
1149                             opaque_decl.concrete_ty,
1150                             infcx.resolve_type_vars_if_possible(&opaque_decl.concrete_ty),
1151                             opaque_defn_ty
1152                         );
1153                         obligations.add(infcx
1154                             .at(&ObligationCause::dummy(), param_env)
1155                             .eq(opaque_decl.concrete_ty, opaque_defn_ty)?);
1156                     }
1157
1158                     debug!("eq_opaque_type_and_type: equated");
1159
1160                     Ok(InferOk {
1161                         value: Some(opaque_type_map),
1162                         obligations: obligations.into_vec(),
1163                     })
1164                 },
1165                 || "input_output".to_string(),
1166             ),
1167         )?;
1168
1169         let universal_region_relations = match self.universal_region_relations {
1170             Some(rel) => rel,
1171             None => return Ok(()),
1172         };
1173
1174         // Finally, if we instantiated the anon types successfully, we
1175         // have to solve any bounds (e.g., `-> impl Iterator` needs to
1176         // prove that `T: Iterator` where `T` is the type we
1177         // instantiated it with).
1178         if let Some(opaque_type_map) = opaque_type_map {
1179             for (opaque_def_id, opaque_decl) in opaque_type_map {
1180                 self.fully_perform_op(
1181                     locations,
1182                     ConstraintCategory::OpaqueType,
1183                     CustomTypeOp::new(
1184                         |_cx| {
1185                             infcx.constrain_opaque_type(
1186                                 opaque_def_id,
1187                                 &opaque_decl,
1188                                 universal_region_relations,
1189                             );
1190                             Ok(InferOk {
1191                                 value: (),
1192                                 obligations: vec![],
1193                             })
1194                         },
1195                         || "opaque_type_map".to_string(),
1196                     ),
1197                 )?;
1198             }
1199         }
1200         Ok(())
1201     }
1202
1203     fn tcx(&self) -> TyCtxt<'a, 'gcx, 'tcx> {
1204         self.infcx.tcx
1205     }
1206
1207     fn check_stmt(&mut self, mir: &Mir<'tcx>, stmt: &Statement<'tcx>, location: Location) {
1208         debug!("check_stmt: {:?}", stmt);
1209         let tcx = self.tcx();
1210         match stmt.kind {
1211             StatementKind::Assign(ref place, ref rv) => {
1212                 // Assignments to temporaries are not "interesting";
1213                 // they are not caused by the user, but rather artifacts
1214                 // of lowering. Assignments to other sorts of places *are* interesting
1215                 // though.
1216                 let category = match *place {
1217                     Place::Local(RETURN_PLACE) => if let Some(BorrowCheckContext {
1218                         universal_regions:
1219                             UniversalRegions {
1220                                 defining_ty: DefiningTy::Const(def_id, _),
1221                                 ..
1222                             },
1223                         ..
1224                     }) = self.borrowck_context
1225                     {
1226                         if tcx.is_static(*def_id).is_some() {
1227                             ConstraintCategory::UseAsStatic
1228                         } else {
1229                             ConstraintCategory::UseAsConst
1230                         }
1231                     } else {
1232                         ConstraintCategory::Return
1233                     },
1234                     Place::Local(l) if !mir.local_decls[l].is_user_variable.is_some() => {
1235                         ConstraintCategory::Boring
1236                     }
1237                     _ => ConstraintCategory::Assignment,
1238                 };
1239
1240                 let place_ty = place.ty(mir, tcx).to_ty(tcx);
1241                 let rv_ty = rv.ty(mir, tcx);
1242                 if let Err(terr) =
1243                     self.sub_types_or_anon(rv_ty, place_ty, location.to_locations(), category)
1244                 {
1245                     span_mirbug!(
1246                         self,
1247                         stmt,
1248                         "bad assignment ({:?} = {:?}): {:?}",
1249                         place_ty,
1250                         rv_ty,
1251                         terr
1252                     );
1253                 }
1254
1255                 if let Some(user_ty) = self.rvalue_user_ty(rv) {
1256                     if let Err(terr) = self.relate_type_and_user_type(
1257                         rv_ty,
1258                         ty::Variance::Invariant,
1259                         user_ty,
1260                         location.to_locations(),
1261                         ConstraintCategory::Boring,
1262                     ) {
1263                         span_mirbug!(
1264                             self,
1265                             stmt,
1266                             "bad user type on rvalue ({:?} = {:?}): {:?}",
1267                             user_ty,
1268                             rv_ty,
1269                             terr
1270                         );
1271                     }
1272                 }
1273
1274                 self.check_rvalue(mir, rv, location);
1275                 if !self.tcx().features().unsized_locals {
1276                     let trait_ref = ty::TraitRef {
1277                         def_id: tcx.lang_items().sized_trait().unwrap(),
1278                         substs: tcx.mk_substs_trait(place_ty, &[]),
1279                     };
1280                     self.prove_trait_ref(
1281                         trait_ref,
1282                         location.to_locations(),
1283                         ConstraintCategory::SizedBound,
1284                     );
1285                 }
1286             }
1287             StatementKind::SetDiscriminant {
1288                 ref place,
1289                 variant_index,
1290             } => {
1291                 let place_type = place.ty(mir, tcx).to_ty(tcx);
1292                 let adt = match place_type.sty {
1293                     TyKind::Adt(adt, _) if adt.is_enum() => adt,
1294                     _ => {
1295                         span_bug!(
1296                             stmt.source_info.span,
1297                             "bad set discriminant ({:?} = {:?}): lhs is not an enum",
1298                             place,
1299                             variant_index
1300                         );
1301                     }
1302                 };
1303                 if variant_index >= adt.variants.len() {
1304                     span_bug!(
1305                         stmt.source_info.span,
1306                         "bad set discriminant ({:?} = {:?}): value of of range",
1307                         place,
1308                         variant_index
1309                     );
1310                 };
1311             }
1312             StatementKind::AscribeUserType(ref place, variance, c_ty) => {
1313                 let place_ty = place.ty(mir, tcx).to_ty(tcx);
1314                 if let Err(terr) = self.relate_type_and_user_type(
1315                     place_ty,
1316                     variance,
1317                     c_ty,
1318                     Locations::All(stmt.source_info.span),
1319                     ConstraintCategory::TypeAnnotation,
1320                 ) {
1321                     span_mirbug!(
1322                         self,
1323                         stmt,
1324                         "bad type assert ({:?} <: {:?}): {:?}",
1325                         place_ty,
1326                         c_ty,
1327                         terr
1328                     );
1329                 }
1330             }
1331             StatementKind::FakeRead(..)
1332             | StatementKind::StorageLive(_)
1333             | StatementKind::StorageDead(_)
1334             | StatementKind::InlineAsm { .. }
1335             | StatementKind::EndRegion(_)
1336             | StatementKind::Validate(..)
1337             | StatementKind::Nop => {}
1338         }
1339     }
1340
1341     fn check_terminator(
1342         &mut self,
1343         mir: &Mir<'tcx>,
1344         term: &Terminator<'tcx>,
1345         term_location: Location,
1346     ) {
1347         debug!("check_terminator: {:?}", term);
1348         let tcx = self.tcx();
1349         match term.kind {
1350             TerminatorKind::Goto { .. }
1351             | TerminatorKind::Resume
1352             | TerminatorKind::Abort
1353             | TerminatorKind::Return
1354             | TerminatorKind::GeneratorDrop
1355             | TerminatorKind::Unreachable
1356             | TerminatorKind::Drop { .. }
1357             | TerminatorKind::FalseEdges { .. }
1358             | TerminatorKind::FalseUnwind { .. } => {
1359                 // no checks needed for these
1360             }
1361
1362             TerminatorKind::DropAndReplace {
1363                 ref location,
1364                 ref value,
1365                 target: _,
1366                 unwind: _,
1367             } => {
1368                 let place_ty = location.ty(mir, tcx).to_ty(tcx);
1369                 let rv_ty = value.ty(mir, tcx);
1370
1371                 let locations = term_location.to_locations();
1372                 if let Err(terr) =
1373                     self.sub_types(rv_ty, place_ty, locations, ConstraintCategory::Assignment)
1374                 {
1375                     span_mirbug!(
1376                         self,
1377                         term,
1378                         "bad DropAndReplace ({:?} = {:?}): {:?}",
1379                         place_ty,
1380                         rv_ty,
1381                         terr
1382                     );
1383                 }
1384             }
1385             TerminatorKind::SwitchInt {
1386                 ref discr,
1387                 switch_ty,
1388                 ..
1389             } => {
1390                 let discr_ty = discr.ty(mir, tcx);
1391                 if let Err(terr) = self.sub_types(
1392                     discr_ty,
1393                     switch_ty,
1394                     term_location.to_locations(),
1395                     ConstraintCategory::Assignment,
1396                 ) {
1397                     span_mirbug!(
1398                         self,
1399                         term,
1400                         "bad SwitchInt ({:?} on {:?}): {:?}",
1401                         switch_ty,
1402                         discr_ty,
1403                         terr
1404                     );
1405                 }
1406                 if !switch_ty.is_integral() && !switch_ty.is_char() && !switch_ty.is_bool() {
1407                     span_mirbug!(self, term, "bad SwitchInt discr ty {:?}", switch_ty);
1408                 }
1409                 // FIXME: check the values
1410             }
1411             TerminatorKind::Call {
1412                 ref func,
1413                 ref args,
1414                 ref destination,
1415                 from_hir_call,
1416                 ..
1417             } => {
1418                 let func_ty = func.ty(mir, tcx);
1419                 debug!("check_terminator: call, func_ty={:?}", func_ty);
1420                 let sig = match func_ty.sty {
1421                     ty::FnDef(..) | ty::FnPtr(_) => func_ty.fn_sig(tcx),
1422                     _ => {
1423                         span_mirbug!(self, term, "call to non-function {:?}", func_ty);
1424                         return;
1425                     }
1426                 };
1427                 let (sig, map) = self.infcx.replace_late_bound_regions_with_fresh_var(
1428                     term.source_info.span,
1429                     LateBoundRegionConversionTime::FnCall,
1430                     &sig,
1431                 );
1432                 let sig = self.normalize(sig, term_location);
1433                 self.check_call_dest(mir, term, &sig, destination, term_location);
1434
1435                 self.prove_predicates(
1436                     sig.inputs().iter().map(|ty| ty::Predicate::WellFormed(ty)),
1437                     term_location.to_locations(),
1438                     ConstraintCategory::Boring,
1439                 );
1440
1441                 // The ordinary liveness rules will ensure that all
1442                 // regions in the type of the callee are live here. We
1443                 // then further constrain the late-bound regions that
1444                 // were instantiated at the call site to be live as
1445                 // well. The resulting is that all the input (and
1446                 // output) types in the signature must be live, since
1447                 // all the inputs that fed into it were live.
1448                 for &late_bound_region in map.values() {
1449                     if let Some(ref mut borrowck_context) = self.borrowck_context {
1450                         let region_vid = borrowck_context
1451                             .universal_regions
1452                             .to_region_vid(late_bound_region);
1453                         borrowck_context
1454                             .constraints
1455                             .liveness_constraints
1456                             .add_element(region_vid, term_location);
1457                     }
1458                 }
1459
1460                 self.check_call_inputs(mir, term, &sig, args, term_location, from_hir_call);
1461             }
1462             TerminatorKind::Assert {
1463                 ref cond, ref msg, ..
1464             } => {
1465                 let cond_ty = cond.ty(mir, tcx);
1466                 if cond_ty != tcx.types.bool {
1467                     span_mirbug!(self, term, "bad Assert ({:?}, not bool", cond_ty);
1468                 }
1469
1470                 if let BoundsCheck { ref len, ref index } = *msg {
1471                     if len.ty(mir, tcx) != tcx.types.usize {
1472                         span_mirbug!(self, len, "bounds-check length non-usize {:?}", len)
1473                     }
1474                     if index.ty(mir, tcx) != tcx.types.usize {
1475                         span_mirbug!(self, index, "bounds-check index non-usize {:?}", index)
1476                     }
1477                 }
1478             }
1479             TerminatorKind::Yield { ref value, .. } => {
1480                 let value_ty = value.ty(mir, tcx);
1481                 match mir.yield_ty {
1482                     None => span_mirbug!(self, term, "yield in non-generator"),
1483                     Some(ty) => {
1484                         if let Err(terr) = self.sub_types(
1485                             value_ty,
1486                             ty,
1487                             term_location.to_locations(),
1488                             ConstraintCategory::Return,
1489                         ) {
1490                             span_mirbug!(
1491                                 self,
1492                                 term,
1493                                 "type of yield value is {:?}, but the yield type is {:?}: {:?}",
1494                                 value_ty,
1495                                 ty,
1496                                 terr
1497                             );
1498                         }
1499                     }
1500                 }
1501             }
1502         }
1503     }
1504
1505     fn check_call_dest(
1506         &mut self,
1507         mir: &Mir<'tcx>,
1508         term: &Terminator<'tcx>,
1509         sig: &ty::FnSig<'tcx>,
1510         destination: &Option<(Place<'tcx>, BasicBlock)>,
1511         term_location: Location,
1512     ) {
1513         let tcx = self.tcx();
1514         match *destination {
1515             Some((ref dest, _target_block)) => {
1516                 let dest_ty = dest.ty(mir, tcx).to_ty(tcx);
1517                 let category = match *dest {
1518                     Place::Local(RETURN_PLACE) => {
1519                         if let Some(BorrowCheckContext {
1520                             universal_regions:
1521                                 UniversalRegions {
1522                                     defining_ty: DefiningTy::Const(def_id, _),
1523                                     ..
1524                                 },
1525                             ..
1526                         }) = self.borrowck_context
1527                         {
1528                             if tcx.is_static(*def_id).is_some() {
1529                                 ConstraintCategory::UseAsStatic
1530                             } else {
1531                                 ConstraintCategory::UseAsConst
1532                             }
1533                         } else {
1534                             ConstraintCategory::Return
1535                         }
1536                     }
1537                     Place::Local(l) if !mir.local_decls[l].is_user_variable.is_some() => {
1538                         ConstraintCategory::Boring
1539                     }
1540                     _ => ConstraintCategory::Assignment,
1541                 };
1542
1543                 let locations = term_location.to_locations();
1544
1545                 if let Err(terr) =
1546                     self.sub_types_or_anon(sig.output(), dest_ty, locations, category)
1547                 {
1548                     span_mirbug!(
1549                         self,
1550                         term,
1551                         "call dest mismatch ({:?} <- {:?}): {:?}",
1552                         dest_ty,
1553                         sig.output(),
1554                         terr
1555                     );
1556                 }
1557
1558                 // When `#![feature(unsized_locals)]` is not enabled,
1559                 // this check is done at `check_local`.
1560                 if self.tcx().features().unsized_locals {
1561                     let span = term.source_info.span;
1562                     self.ensure_place_sized(dest_ty, span);
1563                 }
1564             }
1565             None => {
1566                 // FIXME(canndrew): This is_never should probably be an is_uninhabited
1567                 if !sig.output().is_never() {
1568                     span_mirbug!(self, term, "call to converging function {:?} w/o dest", sig);
1569                 }
1570             }
1571         }
1572     }
1573
1574     fn check_call_inputs(
1575         &mut self,
1576         mir: &Mir<'tcx>,
1577         term: &Terminator<'tcx>,
1578         sig: &ty::FnSig<'tcx>,
1579         args: &[Operand<'tcx>],
1580         term_location: Location,
1581         from_hir_call: bool,
1582     ) {
1583         debug!("check_call_inputs({:?}, {:?})", sig, args);
1584         if args.len() < sig.inputs().len() || (args.len() > sig.inputs().len() && !sig.variadic) {
1585             span_mirbug!(self, term, "call to {:?} with wrong # of args", sig);
1586         }
1587         for (n, (fn_arg, op_arg)) in sig.inputs().iter().zip(args).enumerate() {
1588             let op_arg_ty = op_arg.ty(mir, self.tcx());
1589             let category = if from_hir_call {
1590                 ConstraintCategory::CallArgument
1591             } else {
1592                 ConstraintCategory::Boring
1593             };
1594             if let Err(terr) =
1595                 self.sub_types(op_arg_ty, fn_arg, term_location.to_locations(), category)
1596             {
1597                 span_mirbug!(
1598                     self,
1599                     term,
1600                     "bad arg #{:?} ({:?} <- {:?}): {:?}",
1601                     n,
1602                     fn_arg,
1603                     op_arg_ty,
1604                     terr
1605                 );
1606             }
1607         }
1608     }
1609
1610     fn check_iscleanup(&mut self, mir: &Mir<'tcx>, block_data: &BasicBlockData<'tcx>) {
1611         let is_cleanup = block_data.is_cleanup;
1612         self.last_span = block_data.terminator().source_info.span;
1613         match block_data.terminator().kind {
1614             TerminatorKind::Goto { target } => {
1615                 self.assert_iscleanup(mir, block_data, target, is_cleanup)
1616             }
1617             TerminatorKind::SwitchInt { ref targets, .. } => for target in targets {
1618                 self.assert_iscleanup(mir, block_data, *target, is_cleanup);
1619             },
1620             TerminatorKind::Resume => if !is_cleanup {
1621                 span_mirbug!(self, block_data, "resume on non-cleanup block!")
1622             },
1623             TerminatorKind::Abort => if !is_cleanup {
1624                 span_mirbug!(self, block_data, "abort on non-cleanup block!")
1625             },
1626             TerminatorKind::Return => if is_cleanup {
1627                 span_mirbug!(self, block_data, "return on cleanup block")
1628             },
1629             TerminatorKind::GeneratorDrop { .. } => if is_cleanup {
1630                 span_mirbug!(self, block_data, "generator_drop in cleanup block")
1631             },
1632             TerminatorKind::Yield { resume, drop, .. } => {
1633                 if is_cleanup {
1634                     span_mirbug!(self, block_data, "yield in cleanup block")
1635                 }
1636                 self.assert_iscleanup(mir, block_data, resume, is_cleanup);
1637                 if let Some(drop) = drop {
1638                     self.assert_iscleanup(mir, block_data, drop, is_cleanup);
1639                 }
1640             }
1641             TerminatorKind::Unreachable => {}
1642             TerminatorKind::Drop { target, unwind, .. }
1643             | TerminatorKind::DropAndReplace { target, unwind, .. }
1644             | TerminatorKind::Assert {
1645                 target,
1646                 cleanup: unwind,
1647                 ..
1648             } => {
1649                 self.assert_iscleanup(mir, block_data, target, is_cleanup);
1650                 if let Some(unwind) = unwind {
1651                     if is_cleanup {
1652                         span_mirbug!(self, block_data, "unwind on cleanup block")
1653                     }
1654                     self.assert_iscleanup(mir, block_data, unwind, true);
1655                 }
1656             }
1657             TerminatorKind::Call {
1658                 ref destination,
1659                 cleanup,
1660                 ..
1661             } => {
1662                 if let &Some((_, target)) = destination {
1663                     self.assert_iscleanup(mir, block_data, target, is_cleanup);
1664                 }
1665                 if let Some(cleanup) = cleanup {
1666                     if is_cleanup {
1667                         span_mirbug!(self, block_data, "cleanup on cleanup block")
1668                     }
1669                     self.assert_iscleanup(mir, block_data, cleanup, true);
1670                 }
1671             }
1672             TerminatorKind::FalseEdges {
1673                 real_target,
1674                 ref imaginary_targets,
1675             } => {
1676                 self.assert_iscleanup(mir, block_data, real_target, is_cleanup);
1677                 for target in imaginary_targets {
1678                     self.assert_iscleanup(mir, block_data, *target, is_cleanup);
1679                 }
1680             }
1681             TerminatorKind::FalseUnwind {
1682                 real_target,
1683                 unwind,
1684             } => {
1685                 self.assert_iscleanup(mir, block_data, real_target, is_cleanup);
1686                 if let Some(unwind) = unwind {
1687                     if is_cleanup {
1688                         span_mirbug!(
1689                             self,
1690                             block_data,
1691                             "cleanup in cleanup block via false unwind"
1692                         );
1693                     }
1694                     self.assert_iscleanup(mir, block_data, unwind, true);
1695                 }
1696             }
1697         }
1698     }
1699
1700     fn assert_iscleanup(
1701         &mut self,
1702         mir: &Mir<'tcx>,
1703         ctxt: &dyn fmt::Debug,
1704         bb: BasicBlock,
1705         iscleanuppad: bool,
1706     ) {
1707         if mir[bb].is_cleanup != iscleanuppad {
1708             span_mirbug!(
1709                 self,
1710                 ctxt,
1711                 "cleanuppad mismatch: {:?} should be {:?}",
1712                 bb,
1713                 iscleanuppad
1714             );
1715         }
1716     }
1717
1718     fn check_local(&mut self, mir: &Mir<'tcx>, local: Local, local_decl: &LocalDecl<'tcx>) {
1719         match mir.local_kind(local) {
1720             LocalKind::ReturnPointer | LocalKind::Arg => {
1721                 // return values of normal functions are required to be
1722                 // sized by typeck, but return values of ADT constructors are
1723                 // not because we don't include a `Self: Sized` bounds on them.
1724                 //
1725                 // Unbound parts of arguments were never required to be Sized
1726                 // - maybe we should make that a warning.
1727                 return;
1728             }
1729             LocalKind::Var | LocalKind::Temp => {}
1730         }
1731
1732         // When `#![feature(unsized_locals)]` is enabled, only function calls
1733         // and nullary ops are checked in `check_call_dest`.
1734         if !self.tcx().features().unsized_locals {
1735             let span = local_decl.source_info.span;
1736             let ty = local_decl.ty;
1737             self.ensure_place_sized(ty, span);
1738         }
1739     }
1740
1741     fn ensure_place_sized(&mut self, ty: Ty<'tcx>, span: Span) {
1742         let tcx = self.tcx();
1743
1744         // Erase the regions from `ty` to get a global type.  The
1745         // `Sized` bound in no way depends on precise regions, so this
1746         // shouldn't affect `is_sized`.
1747         let gcx = tcx.global_tcx();
1748         let erased_ty = gcx.lift(&tcx.erase_regions(&ty)).unwrap();
1749         if !erased_ty.is_sized(gcx.at(span), self.param_env) {
1750             // in current MIR construction, all non-control-flow rvalue
1751             // expressions evaluate through `as_temp` or `into` a return
1752             // slot or local, so to find all unsized rvalues it is enough
1753             // to check all temps, return slots and locals.
1754             if let None = self.reported_errors.replace((ty, span)) {
1755                 let mut diag = struct_span_err!(
1756                     self.tcx().sess,
1757                     span,
1758                     E0161,
1759                     "cannot move a value of type {0}: the size of {0} \
1760                      cannot be statically determined",
1761                     ty
1762                 );
1763
1764                 // While this is located in `nll::typeck` this error is not
1765                 // an NLL error, it's a required check to prevent creation
1766                 // of unsized rvalues in certain cases:
1767                 // * operand of a box expression
1768                 // * callee in a call expression
1769                 diag.emit();
1770             }
1771         }
1772     }
1773
1774     fn aggregate_field_ty(
1775         &mut self,
1776         ak: &AggregateKind<'tcx>,
1777         field_index: usize,
1778         location: Location,
1779     ) -> Result<Ty<'tcx>, FieldAccessError> {
1780         let tcx = self.tcx();
1781
1782         match *ak {
1783             AggregateKind::Adt(def, variant_index, substs, _, active_field_index) => {
1784                 let variant = &def.variants[variant_index];
1785                 let adj_field_index = active_field_index.unwrap_or(field_index);
1786                 if let Some(field) = variant.fields.get(adj_field_index) {
1787                     Ok(self.normalize(field.ty(tcx, substs), location))
1788                 } else {
1789                     Err(FieldAccessError::OutOfRange {
1790                         field_count: variant.fields.len(),
1791                     })
1792                 }
1793             }
1794             AggregateKind::Closure(def_id, substs) => {
1795                 match substs.upvar_tys(def_id, tcx).nth(field_index) {
1796                     Some(ty) => Ok(ty),
1797                     None => Err(FieldAccessError::OutOfRange {
1798                         field_count: substs.upvar_tys(def_id, tcx).count(),
1799                     }),
1800                 }
1801             }
1802             AggregateKind::Generator(def_id, substs, _) => {
1803                 // Try pre-transform fields first (upvars and current state)
1804                 if let Some(ty) = substs.pre_transforms_tys(def_id, tcx).nth(field_index) {
1805                     Ok(ty)
1806                 } else {
1807                     // Then try `field_tys` which contains all the fields, but it
1808                     // requires the final optimized MIR.
1809                     match substs.field_tys(def_id, tcx).nth(field_index) {
1810                         Some(ty) => Ok(ty),
1811                         None => Err(FieldAccessError::OutOfRange {
1812                             field_count: substs.field_tys(def_id, tcx).count(),
1813                         }),
1814                     }
1815                 }
1816             }
1817             AggregateKind::Array(ty) => Ok(ty),
1818             AggregateKind::Tuple => {
1819                 unreachable!("This should have been covered in check_rvalues");
1820             }
1821         }
1822     }
1823
1824     fn check_rvalue(&mut self, mir: &Mir<'tcx>, rvalue: &Rvalue<'tcx>, location: Location) {
1825         let tcx = self.tcx();
1826
1827         match rvalue {
1828             Rvalue::Aggregate(ak, ops) => {
1829                 self.check_aggregate_rvalue(mir, rvalue, ak, ops, location)
1830             }
1831
1832             Rvalue::Repeat(operand, len) => if *len > 1 {
1833                 let operand_ty = operand.ty(mir, tcx);
1834
1835                 let trait_ref = ty::TraitRef {
1836                     def_id: tcx.lang_items().copy_trait().unwrap(),
1837                     substs: tcx.mk_substs_trait(operand_ty, &[]),
1838                 };
1839
1840                 self.prove_trait_ref(
1841                     trait_ref,
1842                     location.to_locations(),
1843                     ConstraintCategory::CopyBound,
1844                 );
1845             },
1846
1847             Rvalue::NullaryOp(_, ty) => {
1848                 // Even with unsized locals cannot box an unsized value.
1849                 if self.tcx().features().unsized_locals {
1850                     let span = mir.source_info(location).span;
1851                     self.ensure_place_sized(ty, span);
1852                 }
1853
1854                 let trait_ref = ty::TraitRef {
1855                     def_id: tcx.lang_items().sized_trait().unwrap(),
1856                     substs: tcx.mk_substs_trait(ty, &[]),
1857                 };
1858
1859                 self.prove_trait_ref(
1860                     trait_ref,
1861                     location.to_locations(),
1862                     ConstraintCategory::SizedBound,
1863                 );
1864             }
1865
1866             Rvalue::Cast(cast_kind, op, ty) => {
1867                 match cast_kind {
1868                     CastKind::ReifyFnPointer => {
1869                         let fn_sig = op.ty(mir, tcx).fn_sig(tcx);
1870
1871                         // The type that we see in the fcx is like
1872                         // `foo::<'a, 'b>`, where `foo` is the path to a
1873                         // function definition. When we extract the
1874                         // signature, it comes from the `fn_sig` query,
1875                         // and hence may contain unnormalized results.
1876                         let fn_sig = self.normalize(fn_sig, location);
1877
1878                         let ty_fn_ptr_from = tcx.mk_fn_ptr(fn_sig);
1879
1880                         if let Err(terr) = self.eq_types(
1881                             ty_fn_ptr_from,
1882                             ty,
1883                             location.to_locations(),
1884                             ConstraintCategory::Cast,
1885                         ) {
1886                             span_mirbug!(
1887                                 self,
1888                                 rvalue,
1889                                 "equating {:?} with {:?} yields {:?}",
1890                                 ty_fn_ptr_from,
1891                                 ty,
1892                                 terr
1893                             );
1894                         }
1895                     }
1896
1897                     CastKind::ClosureFnPointer => {
1898                         let sig = match op.ty(mir, tcx).sty {
1899                             ty::Closure(def_id, substs) => {
1900                                 substs.closure_sig_ty(def_id, tcx).fn_sig(tcx)
1901                             }
1902                             _ => bug!(),
1903                         };
1904                         let ty_fn_ptr_from = tcx.coerce_closure_fn_ty(sig);
1905
1906                         if let Err(terr) = self.eq_types(
1907                             ty_fn_ptr_from,
1908                             ty,
1909                             location.to_locations(),
1910                             ConstraintCategory::Cast,
1911                         ) {
1912                             span_mirbug!(
1913                                 self,
1914                                 rvalue,
1915                                 "equating {:?} with {:?} yields {:?}",
1916                                 ty_fn_ptr_from,
1917                                 ty,
1918                                 terr
1919                             );
1920                         }
1921                     }
1922
1923                     CastKind::UnsafeFnPointer => {
1924                         let fn_sig = op.ty(mir, tcx).fn_sig(tcx);
1925
1926                         // The type that we see in the fcx is like
1927                         // `foo::<'a, 'b>`, where `foo` is the path to a
1928                         // function definition. When we extract the
1929                         // signature, it comes from the `fn_sig` query,
1930                         // and hence may contain unnormalized results.
1931                         let fn_sig = self.normalize(fn_sig, location);
1932
1933                         let ty_fn_ptr_from = tcx.safe_to_unsafe_fn_ty(fn_sig);
1934
1935                         if let Err(terr) = self.eq_types(
1936                             ty_fn_ptr_from,
1937                             ty,
1938                             location.to_locations(),
1939                             ConstraintCategory::Cast,
1940                         ) {
1941                             span_mirbug!(
1942                                 self,
1943                                 rvalue,
1944                                 "equating {:?} with {:?} yields {:?}",
1945                                 ty_fn_ptr_from,
1946                                 ty,
1947                                 terr
1948                             );
1949                         }
1950                     }
1951
1952                     CastKind::Unsize => {
1953                         let &ty = ty;
1954                         let trait_ref = ty::TraitRef {
1955                             def_id: tcx.lang_items().coerce_unsized_trait().unwrap(),
1956                             substs: tcx.mk_substs_trait(op.ty(mir, tcx), &[ty.into()]),
1957                         };
1958
1959                         self.prove_trait_ref(
1960                             trait_ref,
1961                             location.to_locations(),
1962                             ConstraintCategory::Cast,
1963                         );
1964                     }
1965
1966                     CastKind::Misc => {}
1967                 }
1968             }
1969
1970             Rvalue::Ref(region, _borrow_kind, borrowed_place) => {
1971                 self.add_reborrow_constraint(location, region, borrowed_place);
1972             }
1973
1974             // FIXME: These other cases have to be implemented in future PRs
1975             Rvalue::Use(..)
1976             | Rvalue::Len(..)
1977             | Rvalue::BinaryOp(..)
1978             | Rvalue::CheckedBinaryOp(..)
1979             | Rvalue::UnaryOp(..)
1980             | Rvalue::Discriminant(..) => {}
1981         }
1982     }
1983
1984     /// If this rvalue supports a user-given type annotation, then
1985     /// extract and return it. This represents the final type of the
1986     /// rvalue and will be unified with the inferred type.
1987     fn rvalue_user_ty(&self, rvalue: &Rvalue<'tcx>) -> Option<UserTypeAnnotation<'tcx>> {
1988         match rvalue {
1989             Rvalue::Use(_)
1990             | Rvalue::Repeat(..)
1991             | Rvalue::Ref(..)
1992             | Rvalue::Len(..)
1993             | Rvalue::Cast(..)
1994             | Rvalue::BinaryOp(..)
1995             | Rvalue::CheckedBinaryOp(..)
1996             | Rvalue::NullaryOp(..)
1997             | Rvalue::UnaryOp(..)
1998             | Rvalue::Discriminant(..) => None,
1999
2000             Rvalue::Aggregate(aggregate, _) => match **aggregate {
2001                 AggregateKind::Adt(_, _, _, user_ty, _) => user_ty,
2002                 AggregateKind::Array(_) => None,
2003                 AggregateKind::Tuple => None,
2004                 AggregateKind::Closure(_, _) => None,
2005                 AggregateKind::Generator(_, _, _) => None,
2006             },
2007         }
2008     }
2009
2010     fn check_aggregate_rvalue(
2011         &mut self,
2012         mir: &Mir<'tcx>,
2013         rvalue: &Rvalue<'tcx>,
2014         aggregate_kind: &AggregateKind<'tcx>,
2015         operands: &[Operand<'tcx>],
2016         location: Location,
2017     ) {
2018         let tcx = self.tcx();
2019
2020         self.prove_aggregate_predicates(aggregate_kind, location);
2021
2022         if *aggregate_kind == AggregateKind::Tuple {
2023             // tuple rvalue field type is always the type of the op. Nothing to check here.
2024             return;
2025         }
2026
2027         for (i, operand) in operands.iter().enumerate() {
2028             let field_ty = match self.aggregate_field_ty(aggregate_kind, i, location) {
2029                 Ok(field_ty) => field_ty,
2030                 Err(FieldAccessError::OutOfRange { field_count }) => {
2031                     span_mirbug!(
2032                         self,
2033                         rvalue,
2034                         "accessed field #{} but variant only has {}",
2035                         i,
2036                         field_count
2037                     );
2038                     continue;
2039                 }
2040             };
2041             let operand_ty = operand.ty(mir, tcx);
2042
2043             if let Err(terr) = self.sub_types(
2044                 operand_ty,
2045                 field_ty,
2046                 location.to_locations(),
2047                 ConstraintCategory::Boring,
2048             ) {
2049                 span_mirbug!(
2050                     self,
2051                     rvalue,
2052                     "{:?} is not a subtype of {:?}: {:?}",
2053                     operand_ty,
2054                     field_ty,
2055                     terr
2056                 );
2057             }
2058         }
2059     }
2060
2061     /// Add the constraints that arise from a borrow expression `&'a P` at the location `L`.
2062     ///
2063     /// # Parameters
2064     ///
2065     /// - `location`: the location `L` where the borrow expression occurs
2066     /// - `borrow_region`: the region `'a` associated with the borrow
2067     /// - `borrowed_place`: the place `P` being borrowed
2068     fn add_reborrow_constraint(
2069         &mut self,
2070         location: Location,
2071         borrow_region: ty::Region<'tcx>,
2072         borrowed_place: &Place<'tcx>,
2073     ) {
2074         // These constraints are only meaningful during borrowck:
2075         let BorrowCheckContext {
2076             borrow_set,
2077             location_table,
2078             all_facts,
2079             constraints,
2080             ..
2081         } = match self.borrowck_context {
2082             Some(ref mut borrowck_context) => borrowck_context,
2083             None => return,
2084         };
2085
2086         // In Polonius mode, we also push a `borrow_region` fact
2087         // linking the loan to the region (in some cases, though,
2088         // there is no loan associated with this borrow expression --
2089         // that occurs when we are borrowing an unsafe place, for
2090         // example).
2091         if let Some(all_facts) = all_facts {
2092             if let Some(borrow_index) = borrow_set.location_map.get(&location) {
2093                 let region_vid = borrow_region.to_region_vid();
2094                 all_facts.borrow_region.push((
2095                     region_vid,
2096                     *borrow_index,
2097                     location_table.mid_index(location),
2098                 ));
2099             }
2100         }
2101
2102         // If we are reborrowing the referent of another reference, we
2103         // need to add outlives relationships. In a case like `&mut
2104         // *p`, where the `p` has type `&'b mut Foo`, for example, we
2105         // need to ensure that `'b: 'a`.
2106
2107         let mut borrowed_place = borrowed_place;
2108
2109         debug!(
2110             "add_reborrow_constraint({:?}, {:?}, {:?})",
2111             location, borrow_region, borrowed_place
2112         );
2113         while let Place::Projection(box PlaceProjection { base, elem }) = borrowed_place {
2114             debug!("add_reborrow_constraint - iteration {:?}", borrowed_place);
2115
2116             match *elem {
2117                 ProjectionElem::Deref => {
2118                     let tcx = self.infcx.tcx;
2119                     let base_ty = base.ty(self.mir, tcx).to_ty(tcx);
2120
2121                     debug!("add_reborrow_constraint - base_ty = {:?}", base_ty);
2122                     match base_ty.sty {
2123                         ty::Ref(ref_region, _, mutbl) => {
2124                             constraints.outlives_constraints.push(OutlivesConstraint {
2125                                 sup: ref_region.to_region_vid(),
2126                                 sub: borrow_region.to_region_vid(),
2127                                 locations: location.to_locations(),
2128                                 category: ConstraintCategory::Boring,
2129                             });
2130
2131                             match mutbl {
2132                                 hir::Mutability::MutImmutable => {
2133                                     // Immutable reference. We don't need the base
2134                                     // to be valid for the entire lifetime of
2135                                     // the borrow.
2136                                     break;
2137                                 }
2138                                 hir::Mutability::MutMutable => {
2139                                     // Mutable reference. We *do* need the base
2140                                     // to be valid, because after the base becomes
2141                                     // invalid, someone else can use our mutable deref.
2142
2143                                     // This is in order to make the following function
2144                                     // illegal:
2145                                     // ```
2146                                     // fn unsafe_deref<'a, 'b>(x: &'a &'b mut T) -> &'b mut T {
2147                                     //     &mut *x
2148                                     // }
2149                                     // ```
2150                                     //
2151                                     // As otherwise you could clone `&mut T` using the
2152                                     // following function:
2153                                     // ```
2154                                     // fn bad(x: &mut T) -> (&mut T, &mut T) {
2155                                     //     let my_clone = unsafe_deref(&'a x);
2156                                     //     ENDREGION 'a;
2157                                     //     (my_clone, x)
2158                                     // }
2159                                     // ```
2160                                 }
2161                             }
2162                         }
2163                         ty::RawPtr(..) => {
2164                             // deref of raw pointer, guaranteed to be valid
2165                             break;
2166                         }
2167                         ty::Adt(def, _) if def.is_box() => {
2168                             // deref of `Box`, need the base to be valid - propagate
2169                         }
2170                         _ => bug!("unexpected deref ty {:?} in {:?}", base_ty, borrowed_place),
2171                     }
2172                 }
2173                 ProjectionElem::Field(..)
2174                 | ProjectionElem::Downcast(..)
2175                 | ProjectionElem::Index(..)
2176                 | ProjectionElem::ConstantIndex { .. }
2177                 | ProjectionElem::Subslice { .. } => {
2178                     // other field access
2179                 }
2180             }
2181
2182             // The "propagate" case. We need to check that our base is valid
2183             // for the borrow's lifetime.
2184             borrowed_place = base;
2185         }
2186     }
2187
2188     fn prove_aggregate_predicates(
2189         &mut self,
2190         aggregate_kind: &AggregateKind<'tcx>,
2191         location: Location,
2192     ) {
2193         let tcx = self.tcx();
2194
2195         debug!(
2196             "prove_aggregate_predicates(aggregate_kind={:?}, location={:?})",
2197             aggregate_kind, location
2198         );
2199
2200         let instantiated_predicates = match aggregate_kind {
2201             AggregateKind::Adt(def, _, substs, _, _) => {
2202                 tcx.predicates_of(def.did).instantiate(tcx, substs)
2203             }
2204
2205             // For closures, we have some **extra requirements** we
2206             //
2207             // have to check. In particular, in their upvars and
2208             // signatures, closures often reference various regions
2209             // from the surrounding function -- we call those the
2210             // closure's free regions. When we borrow-check (and hence
2211             // region-check) closures, we may find that the closure
2212             // requires certain relationships between those free
2213             // regions. However, because those free regions refer to
2214             // portions of the CFG of their caller, the closure is not
2215             // in a position to verify those relationships. In that
2216             // case, the requirements get "propagated" to us, and so
2217             // we have to solve them here where we instantiate the
2218             // closure.
2219             //
2220             // Despite the opacity of the previous parapgrah, this is
2221             // actually relatively easy to understand in terms of the
2222             // desugaring. A closure gets desugared to a struct, and
2223             // these extra requirements are basically like where
2224             // clauses on the struct.
2225             AggregateKind::Closure(def_id, ty::ClosureSubsts { substs })
2226             | AggregateKind::Generator(def_id, ty::GeneratorSubsts { substs }, _) => {
2227                 self.prove_closure_bounds(tcx, *def_id, substs, location)
2228             }
2229
2230             AggregateKind::Array(_) | AggregateKind::Tuple => ty::InstantiatedPredicates::empty(),
2231         };
2232
2233         self.normalize_and_prove_instantiated_predicates(
2234             instantiated_predicates,
2235             location.to_locations(),
2236         );
2237     }
2238
2239     fn prove_closure_bounds(
2240         &mut self,
2241         tcx: TyCtxt<'a, 'gcx, 'tcx>,
2242         def_id: DefId,
2243         substs: &'tcx Substs<'tcx>,
2244         location: Location,
2245     ) -> ty::InstantiatedPredicates<'tcx> {
2246         if let Some(closure_region_requirements) = tcx.mir_borrowck(def_id).closure_requirements {
2247             let closure_constraints =
2248                 closure_region_requirements.apply_requirements(tcx, location, def_id, substs);
2249
2250             if let Some(ref mut borrowck_context) = self.borrowck_context {
2251                 let bounds_mapping = closure_constraints
2252                     .iter()
2253                     .enumerate()
2254                     .filter_map(|(idx, constraint)| {
2255                         let ty::OutlivesPredicate(k1, r2) =
2256                             constraint.no_late_bound_regions().unwrap_or_else(|| {
2257                                 bug!("query_constraint {:?} contained bound regions", constraint,);
2258                             });
2259
2260                         match k1.unpack() {
2261                             UnpackedKind::Lifetime(r1) => {
2262                                 // constraint is r1: r2
2263                                 let r1_vid = borrowck_context.universal_regions.to_region_vid(r1);
2264                                 let r2_vid = borrowck_context.universal_regions.to_region_vid(r2);
2265                                 let outlives_requirements =
2266                                     &closure_region_requirements.outlives_requirements[idx];
2267                                 Some((
2268                                     (r1_vid, r2_vid),
2269                                     (
2270                                         outlives_requirements.category,
2271                                         outlives_requirements.blame_span,
2272                                     ),
2273                                 ))
2274                             }
2275                             UnpackedKind::Type(_) => None,
2276                         }
2277                     })
2278                     .collect();
2279
2280                 let existing = borrowck_context
2281                     .constraints
2282                     .closure_bounds_mapping
2283                     .insert(location, bounds_mapping);
2284                 assert!(
2285                     existing.is_none(),
2286                     "Multiple closures at the same location."
2287                 );
2288             }
2289
2290             self.push_region_constraints(
2291                 location.to_locations(),
2292                 ConstraintCategory::ClosureBounds,
2293                 &closure_constraints,
2294             );
2295         }
2296
2297         tcx.predicates_of(def_id).instantiate(tcx, substs)
2298     }
2299
2300     fn prove_trait_ref(
2301         &mut self,
2302         trait_ref: ty::TraitRef<'tcx>,
2303         locations: Locations,
2304         category: ConstraintCategory,
2305     ) {
2306         self.prove_predicates(
2307             Some(ty::Predicate::Trait(
2308                 trait_ref.to_poly_trait_ref().to_poly_trait_predicate(),
2309             )),
2310             locations,
2311             category,
2312         );
2313     }
2314
2315     fn normalize_and_prove_instantiated_predicates(
2316         &mut self,
2317         instantiated_predicates: ty::InstantiatedPredicates<'tcx>,
2318         locations: Locations,
2319     ) {
2320         for predicate in instantiated_predicates.predicates {
2321             let predicate = self.normalize(predicate, locations);
2322             self.prove_predicate(predicate, locations, ConstraintCategory::Boring);
2323         }
2324     }
2325
2326     fn prove_predicates(
2327         &mut self,
2328         predicates: impl IntoIterator<Item = ty::Predicate<'tcx>>,
2329         locations: Locations,
2330         category: ConstraintCategory,
2331     ) {
2332         for predicate in predicates {
2333             debug!(
2334                 "prove_predicates(predicate={:?}, locations={:?})",
2335                 predicate, locations,
2336             );
2337
2338             self.prove_predicate(predicate, locations, category);
2339         }
2340     }
2341
2342     fn prove_predicate(
2343         &mut self,
2344         predicate: ty::Predicate<'tcx>,
2345         locations: Locations,
2346         category: ConstraintCategory,
2347     ) {
2348         debug!(
2349             "prove_predicate(predicate={:?}, location={:?})",
2350             predicate, locations,
2351         );
2352
2353         let param_env = self.param_env;
2354         self.fully_perform_op(
2355             locations,
2356             category,
2357             param_env.and(type_op::prove_predicate::ProvePredicate::new(predicate)),
2358         ).unwrap_or_else(|NoSolution| {
2359             span_mirbug!(self, NoSolution, "could not prove {:?}", predicate);
2360         })
2361     }
2362
2363     fn typeck_mir(&mut self, mir: &Mir<'tcx>) {
2364         self.last_span = mir.span;
2365         debug!("run_on_mir: {:?}", mir.span);
2366
2367         for (local, local_decl) in mir.local_decls.iter_enumerated() {
2368             self.check_local(mir, local, local_decl);
2369         }
2370
2371         for (block, block_data) in mir.basic_blocks().iter_enumerated() {
2372             let mut location = Location {
2373                 block,
2374                 statement_index: 0,
2375             };
2376             for stmt in &block_data.statements {
2377                 if !stmt.source_info.span.is_dummy() {
2378                     self.last_span = stmt.source_info.span;
2379                 }
2380                 self.check_stmt(mir, stmt, location);
2381                 location.statement_index += 1;
2382             }
2383
2384             self.check_terminator(mir, block_data.terminator(), location);
2385             self.check_iscleanup(mir, block_data);
2386         }
2387     }
2388
2389     fn normalize<T>(&mut self, value: T, location: impl NormalizeLocation) -> T
2390     where
2391         T: type_op::normalize::Normalizable<'gcx, 'tcx> + Copy,
2392     {
2393         debug!("normalize(value={:?}, location={:?})", value, location);
2394         let param_env = self.param_env;
2395         self.fully_perform_op(
2396             location.to_locations(),
2397             ConstraintCategory::Boring,
2398             param_env.and(type_op::normalize::Normalize::new(value)),
2399         ).unwrap_or_else(|NoSolution| {
2400             span_mirbug!(self, NoSolution, "failed to normalize `{:?}`", value);
2401             value
2402         })
2403     }
2404 }
2405
2406 pub struct TypeckMir;
2407
2408 impl MirPass for TypeckMir {
2409     fn run_pass<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, src: MirSource, mir: &mut Mir<'tcx>) {
2410         let def_id = src.def_id;
2411         debug!("run_pass: {:?}", def_id);
2412
2413         // When NLL is enabled, the borrow checker runs the typeck
2414         // itself, so we don't need this MIR pass anymore.
2415         if tcx.use_mir_borrowck() {
2416             return;
2417         }
2418
2419         if tcx.sess.err_count() > 0 {
2420             // compiling a broken program can obviously result in a
2421             // broken MIR, so try not to report duplicate errors.
2422             return;
2423         }
2424
2425         if tcx.is_struct_constructor(def_id) {
2426             // We just assume that the automatically generated struct constructors are
2427             // correct. See the comment in the `mir_borrowck` implementation for an
2428             // explanation why we need this.
2429             return;
2430         }
2431
2432         let param_env = tcx.param_env(def_id);
2433         tcx.infer_ctxt().enter(|infcx| {
2434             type_check_internal(
2435                 &infcx,
2436                 def_id,
2437                 param_env,
2438                 mir,
2439                 &vec![],
2440                 None,
2441                 None,
2442                 None,
2443                 |_| (),
2444             );
2445
2446             // For verification purposes, we just ignore the resulting
2447             // region constraint sets. Not our problem. =)
2448         });
2449     }
2450 }
2451
2452 trait NormalizeLocation: fmt::Debug + Copy {
2453     fn to_locations(self) -> Locations;
2454 }
2455
2456 impl NormalizeLocation for Locations {
2457     fn to_locations(self) -> Locations {
2458         self
2459     }
2460 }
2461
2462 impl NormalizeLocation for Location {
2463     fn to_locations(self) -> Locations {
2464         Locations::Single(self)
2465     }
2466 }
2467
2468 #[derive(Debug, Default)]
2469 struct ObligationAccumulator<'tcx> {
2470     obligations: PredicateObligations<'tcx>,
2471 }
2472
2473 impl<'tcx> ObligationAccumulator<'tcx> {
2474     fn add<T>(&mut self, value: InferOk<'tcx, T>) -> T {
2475         let InferOk { value, obligations } = value;
2476         self.obligations.extend(obligations);
2477         value
2478     }
2479
2480     fn into_vec(self) -> PredicateObligations<'tcx> {
2481         self.obligations
2482     }
2483 }