src/librustc_typeck/check/writeback.rs

   1 // Copyright 2014 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 // Type resolution: the phase that finds all the types in the AST with
  12 // unresolved type variables and replaces "ty_var" types with their
  13 // substitutions.
  14
  15 use check::FnCtxt;
  16 use rustc::hir;
  17 use rustc::hir::def_id::{DefId, DefIndex};
  18 use rustc::hir::intravisit::{self, Visitor, NestedVisitorMap};
  19 use rustc::infer::{InferCtxt};
  20 use rustc::ty::{self, Ty, TyCtxt};
  21 use rustc::ty::fold::{TypeFolder,TypeFoldable};
  22 use rustc::util::nodemap::DefIdSet;
  23 use syntax::ast;
  24 use syntax_pos::Span;
  25 use std::mem;
  26
  27 ///////////////////////////////////////////////////////////////////////////
  28 // Entry point
  29
  30 impl<'a, 'gcx, 'tcx> FnCtxt<'a, 'gcx, 'tcx> {
  31     pub fn resolve_type_vars_in_body(&self, body: &'gcx hir::Body)
  32                                      -> &'gcx ty::TypeckTables<'gcx> {
  33         let item_id = self.tcx.hir.body_owner(body.id());
  34         let item_def_id = self.tcx.hir.local_def_id(item_id);
  35
  36         let mut wbcx = WritebackCx::new(self, body);
  37         for arg in &body.arguments {
  38             wbcx.visit_node_id(arg.pat.span, arg.hir_id);
  39         }
  40         wbcx.visit_body(body);
  41         wbcx.visit_upvar_borrow_map();
  42         wbcx.visit_closures();
  43         wbcx.visit_liberated_fn_sigs();
  44         wbcx.visit_fru_field_types();
  45         wbcx.visit_anon_types();
  46         wbcx.visit_cast_types();
  47         wbcx.visit_free_region_map();
  48         wbcx.visit_generator_sigs();
  49         wbcx.visit_generator_interiors();
  50
  51         let used_trait_imports = mem::replace(&mut self.tables.borrow_mut().used_trait_imports,
  52                                               DefIdSet());
  53         debug!("used_trait_imports({:?}) = {:?}", item_def_id, used_trait_imports);
  54         wbcx.tables.used_trait_imports = used_trait_imports;
  55
  56         wbcx.tables.tainted_by_errors = self.is_tainted_by_errors();
  57
  58         self.tcx.alloc_tables(wbcx.tables)
  59     }
  60 }
  61
  62 ///////////////////////////////////////////////////////////////////////////
  63 // The Writerback context. This visitor walks the AST, checking the
  64 // fn-specific tables to find references to types or regions. It
  65 // resolves those regions to remove inference variables and writes the
  66 // final result back into the master tables in the tcx. Here and
  67 // there, it applies a few ad-hoc checks that were not convenient to
  68 // do elsewhere.
  69
  70 struct WritebackCx<'cx, 'gcx: 'cx+'tcx, 'tcx: 'cx> {
  71     fcx: &'cx FnCtxt<'cx, 'gcx, 'tcx>,
  72
  73     tables: ty::TypeckTables<'gcx>,
  74
  75     body: &'gcx hir::Body,
  76 }
  77
  78 impl<'cx, 'gcx, 'tcx> WritebackCx<'cx, 'gcx, 'tcx> {
  79     fn new(fcx: &'cx FnCtxt<'cx, 'gcx, 'tcx>, body: &'gcx hir::Body)
  80         -> WritebackCx<'cx, 'gcx, 'tcx>
  81     {
  82         let owner = fcx.tcx.hir.definitions().node_to_hir_id(body.id().node_id);
  83
  84         WritebackCx {
  85             fcx,
  86             tables: ty::TypeckTables::empty(Some(DefId::local(owner.owner))),
  87             body,
  88         }
  89     }
  90
  91     fn tcx(&self) -> TyCtxt<'cx, 'gcx, 'tcx> {
  92         self.fcx.tcx
  93     }
  94
  95     fn write_ty_to_tables(&mut self, hir_id: hir::HirId, ty: Ty<'gcx>) {
  96         debug!("write_ty_to_tables({:?}, {:?})", hir_id,  ty);
  97         assert!(!ty.needs_infer());
  98         self.tables.node_types_mut().insert(hir_id, ty);
  99     }
 100
 101     // Hacky hack: During type-checking, we treat *all* operators
 102     // as potentially overloaded. But then, during writeback, if
 103     // we observe that something like `a+b` is (known to be)
 104     // operating on scalars, we clear the overload.
 105     fn fix_scalar_builtin_expr(&mut self, e: &hir::Expr) {
 106         match e.node {
 107             hir::ExprUnary(hir::UnNeg, ref inner) |
 108             hir::ExprUnary(hir::UnNot, ref inner)  => {
 109                 let inner_ty = self.fcx.node_ty(inner.hir_id);
 110                 let inner_ty = self.fcx.resolve_type_vars_if_possible(&inner_ty);
 111
 112                 if inner_ty.is_scalar() {
 113                     let mut tables = self.fcx.tables.borrow_mut();
 114                     tables.type_dependent_defs_mut().remove(e.hir_id);
 115                     tables.node_substs_mut().remove(e.hir_id);
 116                 }
 117             }
 118             hir::ExprBinary(ref op, ref lhs, ref rhs) |
 119             hir::ExprAssignOp(ref op, ref lhs, ref rhs) => {
 120                 let lhs_ty = self.fcx.node_ty(lhs.hir_id);
 121                 let lhs_ty = self.fcx.resolve_type_vars_if_possible(&lhs_ty);
 122
 123                 let rhs_ty = self.fcx.node_ty(rhs.hir_id);
 124                 let rhs_ty = self.fcx.resolve_type_vars_if_possible(&rhs_ty);
 125
 126                 if lhs_ty.is_scalar() && rhs_ty.is_scalar() {
 127                     let mut tables = self.fcx.tables.borrow_mut();
 128                     tables.type_dependent_defs_mut().remove(e.hir_id);
 129                     tables.node_substs_mut().remove(e.hir_id);
 130
 131                     match e.node {
 132                         hir::ExprBinary(..) => {
 133                             if !op.node.is_by_value() {
 134                                 let mut adjustments = tables.adjustments_mut();
 135                                 adjustments.get_mut(lhs.hir_id).map(|a| a.pop());
 136                                 adjustments.get_mut(rhs.hir_id).map(|a| a.pop());
 137                             }
 138                         },
 139                         hir::ExprAssignOp(..) => {
 140                             tables.adjustments_mut().get_mut(lhs.hir_id).map(|a| a.pop());
 141                         },
 142                         _ => {},
 143                     }
 144                 }
 145             }
 146             _ => {},
 147         }
 148     }
 149 }
 150
 151 ///////////////////////////////////////////////////////////////////////////
 152 // Impl of Visitor for Resolver
 153 //
 154 // This is the master code which walks the AST. It delegates most of
 155 // the heavy lifting to the generic visit and resolve functions
 156 // below. In general, a function is made into a `visitor` if it must
 157 // traffic in node-ids or update tables in the type context etc.
 158
 159 impl<'cx, 'gcx, 'tcx> Visitor<'gcx> for WritebackCx<'cx, 'gcx, 'tcx> {
 160     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'gcx> {
 161         NestedVisitorMap::None
 162     }
 163
 164     fn visit_expr(&mut self, e: &'gcx hir::Expr) {
 165         self.fix_scalar_builtin_expr(e);
 166
 167         self.visit_node_id(e.span, e.hir_id);
 168
 169         if let hir::ExprClosure(_, _, body, _, _) = e.node {
 170             let body = self.fcx.tcx.hir.body(body);
 171             for arg in &body.arguments {
 172                 self.visit_node_id(e.span, arg.hir_id);
 173             }
 174
 175             self.visit_body(body);
 176         }
 177
 178         intravisit::walk_expr(self, e);
 179     }
 180
 181     fn visit_block(&mut self, b: &'gcx hir::Block) {
 182         self.visit_node_id(b.span, b.hir_id);
 183         intravisit::walk_block(self, b);
 184     }
 185
 186     fn visit_pat(&mut self, p: &'gcx hir::Pat) {
 187         match p.node {
 188             hir::PatKind::Binding(..) => {
 189                 let bm = *self.fcx
 190                               .tables
 191                               .borrow()
 192                               .pat_binding_modes()
 193                               .get(p.hir_id)
 194                               .expect("missing binding mode");
 195                 self.tables.pat_binding_modes_mut().insert(p.hir_id, bm);
 196             }
 197             _ => {}
 198         };
 199
 200         self.visit_node_id(p.span, p.hir_id);
 201         intravisit::walk_pat(self, p);
 202     }
 203
 204     fn visit_local(&mut self, l: &'gcx hir::Local) {
 205         intravisit::walk_local(self, l);
 206         let var_ty = self.fcx.local_ty(l.span, l.id);
 207         let var_ty = self.resolve(&var_ty, &l.span);
 208         self.write_ty_to_tables(l.hir_id, var_ty);
 209     }
 210
 211     fn visit_ty(&mut self, hir_ty: &'gcx hir::Ty) {
 212         intravisit::walk_ty(self, hir_ty);
 213         let ty = self.fcx.node_ty(hir_ty.hir_id);
 214         let ty = self.resolve(&ty, &hir_ty.span);
 215         self.write_ty_to_tables(hir_ty.hir_id, ty);
 216     }
 217 }
 218
 219 impl<'cx, 'gcx, 'tcx> WritebackCx<'cx, 'gcx, 'tcx> {
 220     fn visit_upvar_borrow_map(&mut self) {
 221         for (upvar_id, upvar_capture) in self.fcx.tables.borrow().upvar_capture_map.iter() {
 222             let new_upvar_capture = match *upvar_capture {
 223                 ty::UpvarCapture::ByValue => ty::UpvarCapture::ByValue,
 224                 ty::UpvarCapture::ByRef(ref upvar_borrow) => {
 225                     let r = upvar_borrow.region;
 226                     let r = self.resolve(&r, &upvar_id.var_id);
 227                     ty::UpvarCapture::ByRef(
 228                         ty::UpvarBorrow { kind: upvar_borrow.kind, region: r })
 229                 }
 230             };
 231             debug!("Upvar capture for {:?} resolved to {:?}",
 232                    upvar_id,
 233                    new_upvar_capture);
 234             self.tables.upvar_capture_map.insert(*upvar_id, new_upvar_capture);
 235         }
 236     }
 237
 238     fn visit_closures(&mut self) {
 239         let fcx_tables = self.fcx.tables.borrow();
 240         debug_assert_eq!(fcx_tables.local_id_root, self.tables.local_id_root);
 241         let common_local_id_root = fcx_tables.local_id_root.unwrap();
 242
 243         for (&id, closure_ty) in fcx_tables.closure_tys().iter() {
 244             let hir_id = hir::HirId {
 245                 owner: common_local_id_root.index,
 246                 local_id: id,
 247             };
 248             let closure_ty = self.resolve(closure_ty, &hir_id);
 249             self.tables.closure_tys_mut().insert(hir_id, closure_ty);
 250         }
 251
 252         for (&id, &closure_kind) in fcx_tables.closure_kinds().iter() {
 253             let hir_id = hir::HirId {
 254                 owner: common_local_id_root.index,
 255                 local_id: id,
 256             };
 257             self.tables.closure_kinds_mut().insert(hir_id, closure_kind);
 258         }
 259     }
 260
 261     fn visit_cast_types(&mut self) {
 262         let fcx_tables = self.fcx.tables.borrow();
 263         let fcx_cast_kinds = fcx_tables.cast_kinds();
 264         debug_assert_eq!(fcx_tables.local_id_root, self.tables.local_id_root);
 265         let mut self_cast_kinds = self.tables.cast_kinds_mut();
 266         let common_local_id_root = fcx_tables.local_id_root.unwrap();
 267
 268         for (&local_id, &cast_kind) in fcx_cast_kinds.iter() {
 269             let hir_id = hir::HirId {
 270                 owner: common_local_id_root.index,
 271                 local_id,
 272             };
 273             self_cast_kinds.insert(hir_id, cast_kind);
 274         }
 275     }
 276
 277     fn visit_free_region_map(&mut self) {
 278         let free_region_map = self.tcx().lift_to_global(&self.fcx.tables.borrow().free_region_map);
 279         let free_region_map = free_region_map.expect("all regions in free-region-map are global");
 280         self.tables.free_region_map = free_region_map;
 281     }
 282
 283     fn visit_anon_types(&mut self) {
 284         let gcx = self.tcx().global_tcx();
 285         for (&node_id, &concrete_ty) in self.fcx.anon_types.borrow().iter() {
 286             let inside_ty = self.resolve(&concrete_ty, &node_id);
 287
 288             // Convert the type from the function into a type valid outside
 289             // the function, by replacing invalid regions with 'static,
 290             // after producing an error for each of them.
 291             let outside_ty = gcx.fold_regions(&inside_ty, &mut false, |r, _| {
 292                 match *r {
 293                     // 'static and early-bound regions are valid.
 294                     ty::ReStatic |
 295                     ty::ReEarlyBound(_) |
 296                     ty::ReEmpty => r,
 297
 298                     ty::ReFree(_) |
 299                     ty::ReLateBound(..) |
 300                     ty::ReScope(_) |
 301                     ty::ReSkolemized(..) => {
 302                         let span = node_id.to_span(&self.fcx.tcx);
 303                         span_err!(self.tcx().sess, span, E0564,
 304                                   "only named lifetimes are allowed in `impl Trait`, \
 305                                    but `{}` was found in the type `{}`", r, inside_ty);
 306                         gcx.types.re_static
 307                     }
 308
 309                     ty::ReVar(_) |
 310                     ty::ReErased => {
 311                         let span = node_id.to_span(&self.fcx.tcx);
 312                         span_bug!(span, "invalid region in impl Trait: {:?}", r);
 313                     }
 314                 }
 315             });
 316
 317             let hir_id = self.tcx().hir.node_to_hir_id(node_id);
 318             self.tables.node_types_mut().insert(hir_id, outside_ty);
 319         }
 320     }
 321
 322     fn visit_node_id(&mut self, span: Span, hir_id: hir::HirId) {
 323         // Export associated path extensions and method resultions.
 324         if let Some(def) = self.fcx
 325                                .tables
 326                                .borrow_mut()
 327                                .type_dependent_defs_mut()
 328                                .remove(hir_id) {
 329             self.tables.type_dependent_defs_mut().insert(hir_id, def);
 330         }
 331
 332         // Resolve any borrowings for the node with id `node_id`
 333         self.visit_adjustments(span, hir_id);
 334
 335         // Resolve the type of the node with id `node_id`
 336         let n_ty = self.fcx.node_ty(hir_id);
 337         let n_ty = self.resolve(&n_ty, &span);
 338         self.write_ty_to_tables(hir_id, n_ty);
 339         debug!("Node {:?} has type {:?}", hir_id, n_ty);
 340
 341         // Resolve any substitutions
 342         if let Some(substs) = self.fcx.tables.borrow().node_substs_opt(hir_id) {
 343             let substs = self.resolve(&substs, &span);
 344             debug!("write_substs_to_tcx({:?}, {:?})", hir_id, substs);
 345             assert!(!substs.needs_infer());
 346             self.tables.node_substs_mut().insert(hir_id, substs);
 347         }
 348     }
 349
 350     fn visit_adjustments(&mut self, span: Span, hir_id: hir::HirId) {
 351         let adjustment = self.fcx
 352                              .tables
 353                              .borrow_mut()
 354                              .adjustments_mut()
 355                              .remove(hir_id);
 356         match adjustment {
 357             None => {
 358                 debug!("No adjustments for node {:?}", hir_id);
 359             }
 360
 361             Some(adjustment) => {
 362                 let resolved_adjustment = self.resolve(&adjustment, &span);
 363                 debug!("Adjustments for node {:?}: {:?}", hir_id, resolved_adjustment);
 364                 self.tables.adjustments_mut().insert(hir_id, resolved_adjustment);
 365             }
 366         }
 367     }
 368
 369     fn visit_generator_interiors(&mut self) {
 370         let common_local_id_root = self.fcx.tables.borrow().local_id_root.unwrap();
 371         for (&id, interior) in self.fcx.tables.borrow().generator_interiors().iter() {
 372             let hir_id = hir::HirId {
 373                 owner: common_local_id_root.index,
 374                 local_id: id,
 375             };
 376             let interior = self.resolve(interior, &hir_id);
 377             self.tables.generator_interiors_mut().insert(hir_id, interior);
 378         }
 379     }
 380
 381     fn visit_generator_sigs(&mut self) {
 382         let common_local_id_root = self.fcx.tables.borrow().local_id_root.unwrap();
 383         for (&id, gen_sig) in self.fcx.tables.borrow().generator_sigs().iter() {
 384             let hir_id = hir::HirId {
 385                 owner: common_local_id_root.index,
 386                 local_id: id,
 387             };
 388             let gen_sig = gen_sig.map(|s| ty::GenSig {
 389                 yield_ty: self.resolve(&s.yield_ty, &hir_id),
 390                 return_ty: self.resolve(&s.return_ty, &hir_id),
 391             });
 392             self.tables.generator_sigs_mut().insert(hir_id, gen_sig);
 393         }
 394     }
 395
 396     fn visit_liberated_fn_sigs(&mut self) {
 397         let fcx_tables = self.fcx.tables.borrow();
 398         debug_assert_eq!(fcx_tables.local_id_root, self.tables.local_id_root);
 399         let common_local_id_root = fcx_tables.local_id_root.unwrap();
 400
 401         for (&local_id, fn_sig) in fcx_tables.liberated_fn_sigs().iter() {
 402             let hir_id = hir::HirId {
 403                 owner: common_local_id_root.index,
 404                 local_id,
 405             };
 406             let fn_sig = self.resolve(fn_sig, &hir_id);
 407             self.tables.liberated_fn_sigs_mut().insert(hir_id, fn_sig.clone());
 408         }
 409     }
 410
 411     fn visit_fru_field_types(&mut self) {
 412         let fcx_tables = self.fcx.tables.borrow();
 413         debug_assert_eq!(fcx_tables.local_id_root, self.tables.local_id_root);
 414         let common_local_id_root = fcx_tables.local_id_root.unwrap();
 415
 416         for (&local_id, ftys) in fcx_tables.fru_field_types().iter() {
 417             let hir_id = hir::HirId {
 418                 owner: common_local_id_root.index,
 419                 local_id,
 420             };
 421             let ftys = self.resolve(ftys, &hir_id);
 422             self.tables.fru_field_types_mut().insert(hir_id, ftys);
 423         }
 424     }
 425
 426     fn resolve<T>(&self, x: &T, span: &Locatable) -> T::Lifted
 427         where T: TypeFoldable<'tcx> + ty::Lift<'gcx>
 428     {
 429         let x = x.fold_with(&mut Resolver::new(self.fcx, span, self.body));
 430         if let Some(lifted) = self.tcx().lift_to_global(&x) {
 431             lifted
 432         } else {
 433             span_bug!(span.to_span(&self.fcx.tcx),
 434                       "writeback: `{:?}` missing from the global type context",
 435                       x);
 436         }
 437     }
 438 }
 439
 440 trait Locatable {
 441     fn to_span(&self, tcx: &TyCtxt) -> Span;
 442 }
 443
 444 impl Locatable for Span {
 445     fn to_span(&self, _: &TyCtxt) -> Span { *self }
 446 }
 447
 448 impl Locatable for ast::NodeId {
 449     fn to_span(&self, tcx: &TyCtxt) -> Span { tcx.hir.span(*self) }
 450 }
 451
 452 impl Locatable for DefIndex {
 453     fn to_span(&self, tcx: &TyCtxt) -> Span {
 454         let node_id = tcx.hir.def_index_to_node_id(*self);
 455         tcx.hir.span(node_id)
 456     }
 457 }
 458
 459 impl Locatable for hir::HirId {
 460     fn to_span(&self, tcx: &TyCtxt) -> Span {
 461         let node_id = tcx.hir.definitions().find_node_for_hir_id(*self);
 462         tcx.hir.span(node_id)
 463     }
 464 }
 465
 466 ///////////////////////////////////////////////////////////////////////////
 467 // The Resolver. This is the type folding engine that detects
 468 // unresolved types and so forth.
 469
 470 struct Resolver<'cx, 'gcx: 'cx+'tcx, 'tcx: 'cx> {
 471     tcx: TyCtxt<'cx, 'gcx, 'tcx>,
 472     infcx: &'cx InferCtxt<'cx, 'gcx, 'tcx>,
 473     span: &'cx Locatable,
 474     body: &'gcx hir::Body,
 475 }
 476
 477 impl<'cx, 'gcx, 'tcx> Resolver<'cx, 'gcx, 'tcx> {
 478     fn new(fcx: &'cx FnCtxt<'cx, 'gcx, 'tcx>, span: &'cx Locatable, body: &'gcx hir::Body)
 479         -> Resolver<'cx, 'gcx, 'tcx>
 480     {
 481         Resolver {
 482             tcx: fcx.tcx,
 483             infcx: fcx,
 484             span,
 485             body,
 486         }
 487     }
 488
 489     fn report_error(&self, t: Ty<'tcx>) {
 490         if !self.tcx.sess.has_errors() {
 491             self.infcx.need_type_info(Some(self.body.id()), self.span.to_span(&self.tcx), t);
 492         }
 493     }
 494 }
 495
 496 impl<'cx, 'gcx, 'tcx> TypeFolder<'gcx, 'tcx> for Resolver<'cx, 'gcx, 'tcx> {
 497     fn tcx<'a>(&'a self) -> TyCtxt<'a, 'gcx, 'tcx> {
 498         self.tcx
 499     }
 500
 501     fn fold_ty(&mut self, t: Ty<'tcx>) -> Ty<'tcx> {
 502         match self.infcx.fully_resolve(&t) {
 503             Ok(t) => t,
 504             Err(_) => {
 505                 debug!("Resolver::fold_ty: input type `{:?}` not fully resolvable",
 506                        t);
 507                 self.report_error(t);
 508                 self.tcx().types.err
 509             }
 510         }
 511     }
 512
 513     // FIXME This should be carefully checked
 514     // We could use `self.report_error` but it doesn't accept a ty::Region, right now.
 515     fn fold_region(&mut self, r: ty::Region<'tcx>) -> ty::Region<'tcx> {
 516         match self.infcx.fully_resolve(&r) {
 517             Ok(r) => r,
 518             Err(_) => {
 519                 self.tcx.types.re_static
 520             }
 521         }
 522     }
 523 }
 524
 525 ///////////////////////////////////////////////////////////////////////////
 526 // During type check, we store promises with the result of trait
 527 // lookup rather than the actual results (because the results are not
 528 // necessarily available immediately). These routines unwind the
 529 // promises. It is expected that we will have already reported any
 530 // errors that may be encountered, so if the promises store an error,
 531 // a dummy result is returned.