src/librustc_typeck/check/upvar.rs

   1 //! ### Inferring borrow kinds for upvars
   2 //!
   3 //! Whenever there is a closure expression, we need to determine how each
   4 //! upvar is used. We do this by initially assigning each upvar an
   5 //! immutable "borrow kind" (see `ty::BorrowKind` for details) and then
   6 //! "escalating" the kind as needed. The borrow kind proceeds according to
   7 //! the following lattice:
   8 //!
   9 //!     ty::ImmBorrow -> ty::UniqueImmBorrow -> ty::MutBorrow
  10 //!
  11 //! So, for example, if we see an assignment `x = 5` to an upvar `x`, we
  12 //! will promote its borrow kind to mutable borrow. If we see an `&mut x`
  13 //! we'll do the same. Naturally, this applies not just to the upvar, but
  14 //! to everything owned by `x`, so the result is the same for something
  15 //! like `x.f = 5` and so on (presuming `x` is not a borrowed pointer to a
  16 //! struct). These adjustments are performed in
  17 //! `adjust_upvar_borrow_kind()` (you can trace backwards through the code
  18 //! from there).
  19 //!
  20 //! The fact that we are inferring borrow kinds as we go results in a
  21 //! semi-hacky interaction with mem-categorization. In particular,
  22 //! mem-categorization will query the current borrow kind as it
  23 //! categorizes, and we'll return the *current* value, but this may get
  24 //! adjusted later. Therefore, in this module, we generally ignore the
  25 //! borrow kind (and derived mutabilities) that are returned from
  26 //! mem-categorization, since they may be inaccurate. (Another option
  27 //! would be to use a unification scheme, where instead of returning a
  28 //! concrete borrow kind like `ty::ImmBorrow`, we return a
  29 //! `ty::InferBorrow(upvar_id)` or something like that, but this would
  30 //! then mean that all later passes would have to check for these figments
  31 //! and report an error, and it just seems like more mess in the end.)
  32
  33 use super::FnCtxt;
  34
  35 use crate::expr_use_visitor as euv;
  36 use crate::mem_categorization as mc;
  37 use crate::mem_categorization::PlaceBase;
  38 use rustc::hir;
  39 use rustc::hir::def_id::DefId;
  40 use rustc::hir::def_id::LocalDefId;
  41 use rustc::hir::intravisit::{self, NestedVisitorMap, Visitor};
  42 use rustc::infer::UpvarRegion;
  43 use rustc::ty::{self, Ty, TyCtxt, UpvarSubsts};
  44 use rustc_data_structures::fx::FxIndexMap;
  45 use rustc_span::Span;
  46 use syntax::ast;
  47
  48 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
  49     pub fn closure_analyze(&self, body: &'tcx hir::Body<'tcx>) {
  50         InferBorrowKindVisitor { fcx: self }.visit_body(body);
  51
  52         // it's our job to process these.
  53         assert!(self.deferred_call_resolutions.borrow().is_empty());
  54     }
  55 }
  56
  57 struct InferBorrowKindVisitor<'a, 'tcx> {
  58     fcx: &'a FnCtxt<'a, 'tcx>,
  59 }
  60
  61 impl<'a, 'tcx> Visitor<'tcx> for InferBorrowKindVisitor<'a, 'tcx> {
  62     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
  63         NestedVisitorMap::None
  64     }
  65
  66     fn visit_expr(&mut self, expr: &'tcx hir::Expr<'tcx>) {
  67         if let hir::ExprKind::Closure(cc, _, body_id, _, _) = expr.kind {
  68             let body = self.fcx.tcx.hir().body(body_id);
  69             self.visit_body(body);
  70             self.fcx.analyze_closure(expr.hir_id, expr.span, body, cc);
  71         }
  72
  73         intravisit::walk_expr(self, expr);
  74     }
  75 }
  76
  77 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
  78     /// Analysis starting point.
  79     fn analyze_closure(
  80         &self,
  81         closure_hir_id: hir::HirId,
  82         span: Span,
  83         body: &hir::Body<'_>,
  84         capture_clause: hir::CaptureBy,
  85     ) {
  86         debug!("analyze_closure(id={:?}, body.id={:?})", closure_hir_id, body.id());
  87
  88         // Extract the type of the closure.
  89         let ty = self.node_ty(closure_hir_id);
  90         let (closure_def_id, substs) = match ty.kind {
  91             ty::Closure(def_id, substs) => (def_id, UpvarSubsts::Closure(substs)),
  92             ty::Generator(def_id, substs, _) => (def_id, UpvarSubsts::Generator(substs)),
  93             ty::Error => {
  94                 // #51714: skip analysis when we have already encountered type errors
  95                 return;
  96             }
  97             _ => {
  98                 span_bug!(
  99                     span,
 100                     "type of closure expr {:?} is not a closure {:?}",
 101                     closure_hir_id,
 102                     ty
 103                 );
 104             }
 105         };
 106
 107         let infer_kind = if let UpvarSubsts::Closure(closure_substs) = substs {
 108             self.closure_kind(closure_def_id, closure_substs).is_none().then_some(closure_substs)
 109         } else {
 110             None
 111         };
 112
 113         if let Some(upvars) = self.tcx.upvars(closure_def_id) {
 114             let mut upvar_list: FxIndexMap<hir::HirId, ty::UpvarId> =
 115                 FxIndexMap::with_capacity_and_hasher(upvars.len(), Default::default());
 116             for (&var_hir_id, _) in upvars.iter() {
 117                 let upvar_id = ty::UpvarId {
 118                     var_path: ty::UpvarPath { hir_id: var_hir_id },
 119                     closure_expr_id: LocalDefId::from_def_id(closure_def_id),
 120                 };
 121                 debug!("seed upvar_id {:?}", upvar_id);
 122                 // Adding the upvar Id to the list of Upvars, which will be added
 123                 // to the map for the closure at the end of the for loop.
 124                 upvar_list.insert(var_hir_id, upvar_id);
 125
 126                 let capture_kind = match capture_clause {
 127                     hir::CaptureBy::Value => ty::UpvarCapture::ByValue,
 128                     hir::CaptureBy::Ref => {
 129                         let origin = UpvarRegion(upvar_id, span);
 130                         let upvar_region = self.next_region_var(origin);
 131                         let upvar_borrow =
 132                             ty::UpvarBorrow { kind: ty::ImmBorrow, region: upvar_region };
 133                         ty::UpvarCapture::ByRef(upvar_borrow)
 134                     }
 135                 };
 136
 137                 self.tables.borrow_mut().upvar_capture_map.insert(upvar_id, capture_kind);
 138             }
 139             // Add the vector of upvars to the map keyed with the closure id.
 140             // This gives us an easier access to them without having to call
 141             // tcx.upvars again..
 142             if !upvar_list.is_empty() {
 143                 self.tables.borrow_mut().upvar_list.insert(closure_def_id, upvar_list);
 144             }
 145         }
 146
 147         let body_owner_def_id = self.tcx.hir().body_owner_def_id(body.id());
 148         assert_eq!(body_owner_def_id, closure_def_id);
 149         let mut delegate = InferBorrowKind {
 150             fcx: self,
 151             closure_def_id,
 152             current_closure_kind: ty::ClosureKind::LATTICE_BOTTOM,
 153             current_origin: None,
 154             adjust_upvar_captures: ty::UpvarCaptureMap::default(),
 155         };
 156         euv::ExprUseVisitor::new(
 157             &mut delegate,
 158             &self.infcx,
 159             body_owner_def_id,
 160             self.param_env,
 161             &self.tables.borrow(),
 162         )
 163         .consume_body(body);
 164
 165         if let Some(closure_substs) = infer_kind {
 166             // Unify the (as yet unbound) type variable in the closure
 167             // substs with the kind we inferred.
 168             let inferred_kind = delegate.current_closure_kind;
 169             let closure_kind_ty = closure_substs.as_closure().kind_ty(closure_def_id, self.tcx);
 170             self.demand_eqtype(span, inferred_kind.to_ty(self.tcx), closure_kind_ty);
 171
 172             // If we have an origin, store it.
 173             if let Some(origin) = delegate.current_origin {
 174                 self.tables.borrow_mut().closure_kind_origins_mut().insert(closure_hir_id, origin);
 175             }
 176         }
 177
 178         self.tables.borrow_mut().upvar_capture_map.extend(delegate.adjust_upvar_captures);
 179
 180         // Now that we've analyzed the closure, we know how each
 181         // variable is borrowed, and we know what traits the closure
 182         // implements (Fn vs FnMut etc). We now have some updates to do
 183         // with that information.
 184         //
 185         // Note that no closure type C may have an upvar of type C
 186         // (though it may reference itself via a trait object). This
 187         // results from the desugaring of closures to a struct like
 188         // `Foo<..., UV0...UVn>`. If one of those upvars referenced
 189         // C, then the type would have infinite size (and the
 190         // inference algorithm will reject it).
 191
 192         // Equate the type variables for the upvars with the actual types.
 193         let final_upvar_tys = self.final_upvar_tys(closure_hir_id);
 194         debug!(
 195             "analyze_closure: id={:?} substs={:?} final_upvar_tys={:?}",
 196             closure_hir_id, substs, final_upvar_tys
 197         );
 198         for (upvar_ty, final_upvar_ty) in
 199             substs.upvar_tys(closure_def_id, self.tcx).zip(final_upvar_tys)
 200         {
 201             self.demand_suptype(span, upvar_ty, final_upvar_ty);
 202         }
 203
 204         // If we are also inferred the closure kind here,
 205         // process any deferred resolutions.
 206         let deferred_call_resolutions = self.remove_deferred_call_resolutions(closure_def_id);
 207         for deferred_call_resolution in deferred_call_resolutions {
 208             deferred_call_resolution.resolve(self);
 209         }
 210     }
 211
 212     // Returns a list of `ClosureUpvar`s for each upvar.
 213     fn final_upvar_tys(&self, closure_id: hir::HirId) -> Vec<Ty<'tcx>> {
 214         // Presently an unboxed closure type cannot "escape" out of a
 215         // function, so we will only encounter ones that originated in the
 216         // local crate or were inlined into it along with some function.
 217         // This may change if abstract return types of some sort are
 218         // implemented.
 219         let tcx = self.tcx;
 220         let closure_def_id = tcx.hir().local_def_id(closure_id);
 221
 222         tcx.upvars(closure_def_id)
 223             .iter()
 224             .flat_map(|upvars| {
 225                 upvars.iter().map(|(&var_hir_id, _)| {
 226                     let upvar_ty = self.node_ty(var_hir_id);
 227                     let upvar_id = ty::UpvarId {
 228                         var_path: ty::UpvarPath { hir_id: var_hir_id },
 229                         closure_expr_id: LocalDefId::from_def_id(closure_def_id),
 230                     };
 231                     let capture = self.tables.borrow().upvar_capture(upvar_id);
 232
 233                     debug!("var_id={:?} upvar_ty={:?} capture={:?}", var_hir_id, upvar_ty, capture);
 234
 235                     match capture {
 236                         ty::UpvarCapture::ByValue => upvar_ty,
 237                         ty::UpvarCapture::ByRef(borrow) => tcx.mk_ref(
 238                             borrow.region,
 239                             ty::TypeAndMut { ty: upvar_ty, mutbl: borrow.kind.to_mutbl_lossy() },
 240                         ),
 241                     }
 242                 })
 243             })
 244             .collect()
 245     }
 246 }
 247
 248 struct InferBorrowKind<'a, 'tcx> {
 249     fcx: &'a FnCtxt<'a, 'tcx>,
 250
 251     // The def-id of the closure whose kind and upvar accesses are being inferred.
 252     closure_def_id: DefId,
 253
 254     // The kind that we have inferred that the current closure
 255     // requires. Note that we *always* infer a minimal kind, even if
 256     // we don't always *use* that in the final result (i.e., sometimes
 257     // we've taken the closure kind from the expectations instead, and
 258     // for generators we don't even implement the closure traits
 259     // really).
 260     current_closure_kind: ty::ClosureKind,
 261
 262     // If we modified `current_closure_kind`, this field contains a `Some()` with the
 263     // variable access that caused us to do so.
 264     current_origin: Option<(Span, ast::Name)>,
 265
 266     // For each upvar that we access, we track the minimal kind of
 267     // access we need (ref, ref mut, move, etc).
 268     adjust_upvar_captures: ty::UpvarCaptureMap<'tcx>,
 269 }
 270
 271 impl<'a, 'tcx> InferBorrowKind<'a, 'tcx> {
 272     fn adjust_upvar_borrow_kind_for_consume(
 273         &mut self,
 274         place: &mc::Place<'tcx>,
 275         mode: euv::ConsumeMode,
 276     ) {
 277         debug!("adjust_upvar_borrow_kind_for_consume(place={:?}, mode={:?})", place, mode);
 278
 279         // we only care about moves
 280         match mode {
 281             euv::Copy => {
 282                 return;
 283             }
 284             euv::Move => {}
 285         }
 286
 287         let tcx = self.fcx.tcx;
 288         let upvar_id = if let PlaceBase::Upvar(upvar_id) = place.base {
 289             upvar_id
 290         } else {
 291             return;
 292         };
 293
 294         debug!("adjust_upvar_borrow_kind_for_consume: upvar={:?}", upvar_id);
 295
 296         // To move out of an upvar, this must be a FnOnce closure
 297         self.adjust_closure_kind(
 298             upvar_id.closure_expr_id,
 299             ty::ClosureKind::FnOnce,
 300             place.span,
 301             var_name(tcx, upvar_id.var_path.hir_id),
 302         );
 303
 304         self.adjust_upvar_captures.insert(upvar_id, ty::UpvarCapture::ByValue);
 305     }
 306
 307     /// Indicates that `place` is being directly mutated (e.g., assigned
 308     /// to). If the place is based on a by-ref upvar, this implies that
 309     /// the upvar must be borrowed using an `&mut` borrow.
 310     fn adjust_upvar_borrow_kind_for_mut(&mut self, place: &mc::Place<'tcx>) {
 311         debug!("adjust_upvar_borrow_kind_for_mut(place={:?})", place);
 312
 313         if let PlaceBase::Upvar(upvar_id) = place.base {
 314             let mut borrow_kind = ty::MutBorrow;
 315             for pointer_ty in place.deref_tys() {
 316                 match pointer_ty.kind {
 317                     // Raw pointers don't inherit mutability.
 318                     ty::RawPtr(_) => return,
 319                     // assignment to deref of an `&mut`
 320                     // borrowed pointer implies that the
 321                     // pointer itself must be unique, but not
 322                     // necessarily *mutable*
 323                     ty::Ref(.., hir::Mutability::Mut) => borrow_kind = ty::UniqueImmBorrow,
 324                     _ => (),
 325                 }
 326             }
 327             self.adjust_upvar_deref(upvar_id, place.span, borrow_kind);
 328         }
 329     }
 330
 331     fn adjust_upvar_borrow_kind_for_unique(&mut self, place: &mc::Place<'tcx>) {
 332         debug!("adjust_upvar_borrow_kind_for_unique(place={:?})", place);
 333
 334         if let PlaceBase::Upvar(upvar_id) = place.base {
 335             if place.deref_tys().any(ty::TyS::is_unsafe_ptr) {
 336                 // Raw pointers don't inherit mutability.
 337                 return;
 338             }
 339             // for a borrowed pointer to be unique, its base must be unique
 340             self.adjust_upvar_deref(upvar_id, place.span, ty::UniqueImmBorrow);
 341         }
 342     }
 343
 344     fn adjust_upvar_deref(
 345         &mut self,
 346         upvar_id: ty::UpvarId,
 347         place_span: Span,
 348         borrow_kind: ty::BorrowKind,
 349     ) {
 350         assert!(match borrow_kind {
 351             ty::MutBorrow => true,
 352             ty::UniqueImmBorrow => true,
 353
 354             // imm borrows never require adjusting any kinds, so we don't wind up here
 355             ty::ImmBorrow => false,
 356         });
 357
 358         let tcx = self.fcx.tcx;
 359
 360         // if this is an implicit deref of an
 361         // upvar, then we need to modify the
 362         // borrow_kind of the upvar to make sure it
 363         // is inferred to mutable if necessary
 364         self.adjust_upvar_borrow_kind(upvar_id, borrow_kind);
 365
 366         // also need to be in an FnMut closure since this is not an ImmBorrow
 367         self.adjust_closure_kind(
 368             upvar_id.closure_expr_id,
 369             ty::ClosureKind::FnMut,
 370             place_span,
 371             var_name(tcx, upvar_id.var_path.hir_id),
 372         );
 373     }
 374
 375     /// We infer the borrow_kind with which to borrow upvars in a stack closure.
 376     /// The borrow_kind basically follows a lattice of `imm < unique-imm < mut`,
 377     /// moving from left to right as needed (but never right to left).
 378     /// Here the argument `mutbl` is the borrow_kind that is required by
 379     /// some particular use.
 380     fn adjust_upvar_borrow_kind(&mut self, upvar_id: ty::UpvarId, kind: ty::BorrowKind) {
 381         let upvar_capture = self
 382             .adjust_upvar_captures
 383             .get(&upvar_id)
 384             .copied()
 385             .unwrap_or_else(|| self.fcx.tables.borrow().upvar_capture(upvar_id));
 386         debug!(
 387             "adjust_upvar_borrow_kind(upvar_id={:?}, upvar_capture={:?}, kind={:?})",
 388             upvar_id, upvar_capture, kind
 389         );
 390
 391         match upvar_capture {
 392             ty::UpvarCapture::ByValue => {
 393                 // Upvar is already by-value, the strongest criteria.
 394             }
 395             ty::UpvarCapture::ByRef(mut upvar_borrow) => {
 396                 match (upvar_borrow.kind, kind) {
 397                     // Take RHS:
 398                     (ty::ImmBorrow, ty::UniqueImmBorrow)
 399                     | (ty::ImmBorrow, ty::MutBorrow)
 400                     | (ty::UniqueImmBorrow, ty::MutBorrow) => {
 401                         upvar_borrow.kind = kind;
 402                         self.adjust_upvar_captures
 403                             .insert(upvar_id, ty::UpvarCapture::ByRef(upvar_borrow));
 404                     }
 405                     // Take LHS:
 406                     (ty::ImmBorrow, ty::ImmBorrow)
 407                     | (ty::UniqueImmBorrow, ty::ImmBorrow)
 408                     | (ty::UniqueImmBorrow, ty::UniqueImmBorrow)
 409                     | (ty::MutBorrow, _) => {}
 410                 }
 411             }
 412         }
 413     }
 414
 415     fn adjust_closure_kind(
 416         &mut self,
 417         closure_id: LocalDefId,
 418         new_kind: ty::ClosureKind,
 419         upvar_span: Span,
 420         var_name: ast::Name,
 421     ) {
 422         debug!(
 423             "adjust_closure_kind(closure_id={:?}, new_kind={:?}, upvar_span={:?}, var_name={})",
 424             closure_id, new_kind, upvar_span, var_name
 425         );
 426
 427         // Is this the closure whose kind is currently being inferred?
 428         if closure_id.to_def_id() != self.closure_def_id {
 429             debug!("adjust_closure_kind: not current closure");
 430             return;
 431         }
 432
 433         // closures start out as `Fn`.
 434         let existing_kind = self.current_closure_kind;
 435
 436         debug!(
 437             "adjust_closure_kind: closure_id={:?}, existing_kind={:?}, new_kind={:?}",
 438             closure_id, existing_kind, new_kind
 439         );
 440
 441         match (existing_kind, new_kind) {
 442             (ty::ClosureKind::Fn, ty::ClosureKind::Fn)
 443             | (ty::ClosureKind::FnMut, ty::ClosureKind::Fn)
 444             | (ty::ClosureKind::FnMut, ty::ClosureKind::FnMut)
 445             | (ty::ClosureKind::FnOnce, _) => {
 446                 // no change needed
 447             }
 448
 449             (ty::ClosureKind::Fn, ty::ClosureKind::FnMut)
 450             | (ty::ClosureKind::Fn, ty::ClosureKind::FnOnce)
 451             | (ty::ClosureKind::FnMut, ty::ClosureKind::FnOnce) => {
 452                 // new kind is stronger than the old kind
 453                 self.current_closure_kind = new_kind;
 454                 self.current_origin = Some((upvar_span, var_name));
 455             }
 456         }
 457     }
 458 }
 459
 460 impl<'a, 'tcx> euv::Delegate<'tcx> for InferBorrowKind<'a, 'tcx> {
 461     fn consume(&mut self, place: &mc::Place<'tcx>, mode: euv::ConsumeMode) {
 462         debug!("consume(place={:?},mode={:?})", place, mode);
 463         self.adjust_upvar_borrow_kind_for_consume(place, mode);
 464     }
 465
 466     fn borrow(&mut self, place: &mc::Place<'tcx>, bk: ty::BorrowKind) {
 467         debug!("borrow(place={:?}, bk={:?})", place, bk);
 468
 469         match bk {
 470             ty::ImmBorrow => {}
 471             ty::UniqueImmBorrow => {
 472                 self.adjust_upvar_borrow_kind_for_unique(place);
 473             }
 474             ty::MutBorrow => {
 475                 self.adjust_upvar_borrow_kind_for_mut(place);
 476             }
 477         }
 478     }
 479
 480     fn mutate(&mut self, assignee_place: &mc::Place<'tcx>) {
 481         debug!("mutate(assignee_place={:?})", assignee_place);
 482
 483         self.adjust_upvar_borrow_kind_for_mut(assignee_place);
 484     }
 485 }
 486
 487 fn var_name(tcx: TyCtxt<'_>, var_hir_id: hir::HirId) -> ast::Name {
 488     tcx.hir().name(var_hir_id)
 489 }