compiler/rustc_typeck/src/check/generator_interior/drop_ranges/cfg_build.rs

   1 use super::{
   2     for_each_consumable, record_consumed_borrow::ConsumedAndBorrowedPlaces, DropRangesBuilder,
   3     NodeInfo, PostOrderId, TrackedValue, TrackedValueIndex,
   4 };
   5 use hir::{
   6     intravisit::{self, Visitor},
   7     Body, Expr, ExprKind, Guard, HirId, LoopIdError,
   8 };
   9 use rustc_data_structures::fx::FxHashMap;
  10 use rustc_hir as hir;
  11 use rustc_index::vec::IndexVec;
  12 use rustc_middle::{
  13     hir::map::Map,
  14     ty::{TyCtxt, TypeckResults},
  15 };
  16 use std::mem::swap;
  17
  18 /// Traverses the body to find the control flow graph and locations for the
  19 /// relevant places are dropped or reinitialized.
  20 ///
  21 /// The resulting structure still needs to be iterated to a fixed point, which
  22 /// can be done with propagate_to_fixpoint in cfg_propagate.
  23 pub(super) fn build_control_flow_graph<'tcx>(
  24     hir: Map<'tcx>,
  25     tcx: TyCtxt<'tcx>,
  26     typeck_results: &TypeckResults<'tcx>,
  27     consumed_borrowed_places: ConsumedAndBorrowedPlaces,
  28     body: &'tcx Body<'tcx>,
  29     num_exprs: usize,
  30 ) -> DropRangesBuilder {
  31     let mut drop_range_visitor =
  32         DropRangeVisitor::new(hir, tcx, typeck_results, consumed_borrowed_places, num_exprs);
  33     intravisit::walk_body(&mut drop_range_visitor, body);
  34
  35     drop_range_visitor.drop_ranges.process_deferred_edges();
  36
  37     drop_range_visitor.drop_ranges
  38 }
  39
  40 /// This struct is used to gather the information for `DropRanges` to determine the regions of the
  41 /// HIR tree for which a value is dropped.
  42 ///
  43 /// We are interested in points where a variables is dropped or initialized, and the control flow
  44 /// of the code. We identify locations in code by their post-order traversal index, so it is
  45 /// important for this traversal to match that in `RegionResolutionVisitor` and `InteriorVisitor`.
  46 ///
  47 /// We make several simplifying assumptions, with the goal of being more conservative than
  48 /// necessary rather than less conservative (since being less conservative is unsound, but more
  49 /// conservative is still safe). These assumptions are:
  50 ///
  51 /// 1. Moving a variable `a` counts as a move of the whole variable.
  52 /// 2. Moving a partial path like `a.b.c` is ignored.
  53 /// 3. Reinitializing through a field (e.g. `a.b.c = 5`) counds as a reinitialization of all of
  54 ///    `a`.
  55 ///
  56 /// Some examples:
  57 ///
  58 /// Rule 1:
  59 /// ```rust
  60 /// let mut a = (vec![0], vec![0]);
  61 /// drop(a);
  62 /// // `a` is not considered initialized.
  63 /// ```
  64 ///
  65 /// Rule 2:
  66 /// ```rust
  67 /// let mut a = (vec![0], vec![0]);
  68 /// drop(a.0);
  69 /// drop(a.1);
  70 /// // `a` is still considered initialized.
  71 /// ```
  72 ///
  73 /// Rule 3:
  74 /// ```rust
  75 /// let mut a = (vec![0], vec![0]);
  76 /// drop(a);
  77 /// a.1 = vec![1];
  78 /// // all of `a` is considered initialized
  79 /// ```
  80
  81 struct DropRangeVisitor<'a, 'tcx> {
  82     hir: Map<'tcx>,
  83     places: ConsumedAndBorrowedPlaces,
  84     drop_ranges: DropRangesBuilder,
  85     expr_index: PostOrderId,
  86     tcx: TyCtxt<'tcx>,
  87     typeck_results: &'a TypeckResults<'tcx>,
  88     label_stack: Vec<(Option<rustc_ast::Label>, PostOrderId)>,
  89 }
  90
  91 impl<'a, 'tcx> DropRangeVisitor<'a, 'tcx> {
  92     fn new(
  93         hir: Map<'tcx>,
  94         tcx: TyCtxt<'tcx>,
  95         typeck_results: &'a TypeckResults<'tcx>,
  96         places: ConsumedAndBorrowedPlaces,
  97         num_exprs: usize,
  98     ) -> Self {
  99         debug!("consumed_places: {:?}", places.consumed);
 100         let drop_ranges = DropRangesBuilder::new(
 101             places.consumed.iter().flat_map(|(_, places)| places.iter().cloned()),
 102             hir,
 103             num_exprs,
 104         );
 105         Self {
 106             hir,
 107             places,
 108             drop_ranges,
 109             expr_index: PostOrderId::from_u32(0),
 110             typeck_results,
 111             tcx,
 112             label_stack: vec![],
 113         }
 114     }
 115
 116     fn record_drop(&mut self, value: TrackedValue) {
 117         if self.places.borrowed.contains(&value) {
 118             debug!("not marking {:?} as dropped because it is borrowed at some point", value);
 119         } else {
 120             debug!("marking {:?} as dropped at {:?}", value, self.expr_index);
 121             let count = self.expr_index;
 122             self.drop_ranges.drop_at(value, count);
 123         }
 124     }
 125
 126     /// ExprUseVisitor's consume callback doesn't go deep enough for our purposes in all
 127     /// expressions. This method consumes a little deeper into the expression when needed.
 128     fn consume_expr(&mut self, expr: &hir::Expr<'_>) {
 129         debug!("consuming expr {:?}, count={:?}", expr.hir_id, self.expr_index);
 130         let places = self
 131             .places
 132             .consumed
 133             .get(&expr.hir_id)
 134             .map_or(vec![], |places| places.iter().cloned().collect());
 135         for place in places {
 136             for_each_consumable(self.hir, place, |value| self.record_drop(value));
 137         }
 138     }
 139
 140     /// Marks an expression as being reinitialized.
 141     ///
 142     /// Note that we always approximated on the side of things being more
 143     /// initialized than they actually are, as opposed to less. In cases such
 144     /// as `x.y = ...`, we would consider all of `x` as being initialized
 145     /// instead of just the `y` field.
 146     ///
 147     /// This is because it is always safe to consider something initialized
 148     /// even when it is not, but the other way around will cause problems.
 149     ///
 150     /// In the future, we will hopefully tighten up these rules to be more
 151     /// precise.
 152     fn reinit_expr(&mut self, expr: &hir::Expr<'_>) {
 153         // Walk the expression to find the base. For example, in an expression
 154         // like `*a[i].x`, we want to find the `a` and mark that as
 155         // reinitialized.
 156         match expr.kind {
 157             ExprKind::Path(hir::QPath::Resolved(
 158                 _,
 159                 hir::Path { res: hir::def::Res::Local(hir_id), .. },
 160             )) => {
 161                 // This is the base case, where we have found an actual named variable.
 162
 163                 let location = self.expr_index;
 164                 debug!("reinitializing {:?} at {:?}", hir_id, location);
 165                 self.drop_ranges.reinit_at(TrackedValue::Variable(*hir_id), location);
 166             }
 167
 168             ExprKind::Field(base, _) => self.reinit_expr(base),
 169
 170             // Most expressions do not refer to something where we need to track
 171             // reinitializations.
 172             //
 173             // Some of these may be interesting in the future
 174             ExprKind::Path(..)
 175             | ExprKind::Box(..)
 176             | ExprKind::ConstBlock(..)
 177             | ExprKind::Array(..)
 178             | ExprKind::Call(..)
 179             | ExprKind::MethodCall(..)
 180             | ExprKind::Tup(..)
 181             | ExprKind::Binary(..)
 182             | ExprKind::Unary(..)
 183             | ExprKind::Lit(..)
 184             | ExprKind::Cast(..)
 185             | ExprKind::Type(..)
 186             | ExprKind::DropTemps(..)
 187             | ExprKind::Let(..)
 188             | ExprKind::If(..)
 189             | ExprKind::Loop(..)
 190             | ExprKind::Match(..)
 191             | ExprKind::Closure(..)
 192             | ExprKind::Block(..)
 193             | ExprKind::Assign(..)
 194             | ExprKind::AssignOp(..)
 195             | ExprKind::Index(..)
 196             | ExprKind::AddrOf(..)
 197             | ExprKind::Break(..)
 198             | ExprKind::Continue(..)
 199             | ExprKind::Ret(..)
 200             | ExprKind::InlineAsm(..)
 201             | ExprKind::Struct(..)
 202             | ExprKind::Repeat(..)
 203             | ExprKind::Yield(..)
 204             | ExprKind::Err => (),
 205         }
 206     }
 207
 208     /// For an expression with an uninhabited return type (e.g. a function that returns !),
 209     /// this adds a self edge to to the CFG to model the fact that the function does not
 210     /// return.
 211     fn handle_uninhabited_return(&mut self, expr: &Expr<'tcx>) {
 212         let ty = self.typeck_results.expr_ty(expr);
 213         let ty = self.tcx.erase_regions(ty);
 214         let m = self.tcx.parent_module(expr.hir_id).to_def_id();
 215         let param_env = self.tcx.param_env(m.expect_local());
 216         if self.tcx.is_ty_uninhabited_from(m, ty, param_env) {
 217             // This function will not return. We model this fact as an infinite loop.
 218             self.drop_ranges.add_control_edge(self.expr_index + 1, self.expr_index + 1);
 219         }
 220     }
 221
 222     /// Map a Destination to an equivalent expression node
 223     ///
 224     /// The destination field of a Break or Continue expression can target either an
 225     /// expression or a block. The drop range analysis, however, only deals in
 226     /// expression nodes, so blocks that might be the destination of a Break or Continue
 227     /// will not have a PostOrderId.
 228     ///
 229     /// If the destination is an expression, this function will simply return that expression's
 230     /// hir_id. If the destination is a block, this function will return the hir_id of last
 231     /// expression in the block.
 232     fn find_target_expression_from_destination(
 233         &self,
 234         destination: hir::Destination,
 235     ) -> Result<HirId, LoopIdError> {
 236         destination.target_id.map(|target| {
 237             let node = self.hir.get(target);
 238             match node {
 239                 hir::Node::Expr(_) => target,
 240                 hir::Node::Block(b) => find_last_block_expression(b),
 241                 hir::Node::Param(..)
 242                 | hir::Node::Item(..)
 243                 | hir::Node::ForeignItem(..)
 244                 | hir::Node::TraitItem(..)
 245                 | hir::Node::ImplItem(..)
 246                 | hir::Node::Variant(..)
 247                 | hir::Node::Field(..)
 248                 | hir::Node::AnonConst(..)
 249                 | hir::Node::Stmt(..)
 250                 | hir::Node::PathSegment(..)
 251                 | hir::Node::Ty(..)
 252                 | hir::Node::TraitRef(..)
 253                 | hir::Node::Binding(..)
 254                 | hir::Node::Pat(..)
 255                 | hir::Node::Arm(..)
 256                 | hir::Node::Local(..)
 257                 | hir::Node::Ctor(..)
 258                 | hir::Node::Lifetime(..)
 259                 | hir::Node::GenericParam(..)
 260                 | hir::Node::Visibility(..)
 261                 | hir::Node::Crate(..)
 262                 | hir::Node::Infer(..) => bug!("Unsupported branch target: {:?}", node),
 263             }
 264         })
 265     }
 266 }
 267
 268 fn find_last_block_expression(block: &hir::Block<'_>) -> HirId {
 269     block.expr.map_or_else(
 270         // If there is no tail expression, there will be at least one statement in the
 271         // block because the block contains a break or continue statement.
 272         || block.stmts.last().unwrap().hir_id,
 273         |expr| expr.hir_id,
 274     )
 275 }
 276
 277 impl<'a, 'tcx> Visitor<'tcx> for DropRangeVisitor<'a, 'tcx> {
 278     fn visit_expr(&mut self, expr: &'tcx Expr<'tcx>) {
 279         let mut reinit = None;
 280         match expr.kind {
 281             ExprKind::Assign(lhs, rhs, _) => {
 282                 self.visit_expr(lhs);
 283                 self.visit_expr(rhs);
 284
 285                 reinit = Some(lhs);
 286             }
 287
 288             ExprKind::If(test, if_true, if_false) => {
 289                 self.visit_expr(test);
 290
 291                 let fork = self.expr_index;
 292
 293                 self.drop_ranges.add_control_edge(fork, self.expr_index + 1);
 294                 self.visit_expr(if_true);
 295                 let true_end = self.expr_index;
 296
 297                 self.drop_ranges.add_control_edge(fork, self.expr_index + 1);
 298                 if let Some(if_false) = if_false {
 299                     self.visit_expr(if_false);
 300                 }
 301
 302                 self.drop_ranges.add_control_edge(true_end, self.expr_index + 1);
 303             }
 304             ExprKind::Match(scrutinee, arms, ..) => {
 305                 // We walk through the match expression almost like a chain of if expressions.
 306                 // Here's a diagram to follow along with:
 307                 //
 308                 //           ┌─┐
 309                 //     match │A│ {
 310                 //       ┌───┴─┘
 311                 //       │
 312                 //      ┌▼┌───►┌─┐   ┌─┐
 313                 //      │B│ if │C│ =>│D│,
 314                 //      └─┘    ├─┴──►└─┴──────┐
 315                 //          ┌──┘              │
 316                 //       ┌──┘                 │
 317                 //       │                    │
 318                 //      ┌▼┌───►┌─┐   ┌─┐      │
 319                 //      │E│ if │F│ =>│G│,     │
 320                 //      └─┘    ├─┴──►└─┴┐     │
 321                 //             │        │     │
 322                 //     }       ▼        ▼     │
 323                 //     ┌─┐◄───────────────────┘
 324                 //     │H│
 325                 //     └─┘
 326                 //
 327                 // The order we want is that the scrutinee (A) flows into the first pattern (B),
 328                 // which flows into the guard (C). Then the guard either flows into the arm body
 329                 // (D) or into the start of the next arm (E). Finally, the body flows to the end
 330                 // of the match block (H).
 331                 //
 332                 // The subsequent arms follow the same ordering. First we go to the pattern, then
 333                 // the guard (if present, otherwise it flows straight into the body), then into
 334                 // the body and then to the end of the match expression.
 335                 //
 336                 // The comments below show which edge is being added.
 337                 self.visit_expr(scrutinee);
 338
 339                 let (guard_exit, arm_end_ids) = arms.iter().fold(
 340                     (self.expr_index, vec![]),
 341                     |(incoming_edge, mut arm_end_ids), hir::Arm { pat, body, guard, .. }| {
 342                         // A -> B, or C -> E
 343                         self.drop_ranges.add_control_edge(incoming_edge, self.expr_index + 1);
 344                         self.visit_pat(pat);
 345                         // B -> C and E -> F are added implicitly due to the traversal order.
 346                         match guard {
 347                             Some(Guard::If(expr)) => self.visit_expr(expr),
 348                             Some(Guard::IfLet(pat, expr)) => {
 349                                 self.visit_pat(pat);
 350                                 self.visit_expr(expr);
 351                             }
 352                             None => (),
 353                         }
 354                         // Likewise, C -> D and F -> G are added implicitly.
 355
 356                         // Save C, F, so we can add the other outgoing edge.
 357                         let to_next_arm = self.expr_index;
 358
 359                         // The default edge does not get added since we also have an explicit edge,
 360                         // so we also need to add an edge to the next node as well.
 361                         //
 362                         // This adds C -> D, F -> G
 363                         self.drop_ranges.add_control_edge(self.expr_index, self.expr_index + 1);
 364                         self.visit_expr(body);
 365
 366                         // Save the end of the body so we can add the exit edge once we know where
 367                         // the exit is.
 368                         arm_end_ids.push(self.expr_index);
 369
 370                         // Pass C to the next iteration, as well as vec![D]
 371                         //
 372                         // On the last round through, we pass F and vec![D, G] so that we can
 373                         // add all the exit edges.
 374                         (to_next_arm, arm_end_ids)
 375                     },
 376                 );
 377                 // F -> H
 378                 self.drop_ranges.add_control_edge(guard_exit, self.expr_index + 1);
 379
 380                 arm_end_ids.into_iter().for_each(|arm_end| {
 381                     // D -> H, G -> H
 382                     self.drop_ranges.add_control_edge(arm_end, self.expr_index + 1)
 383                 });
 384             }
 385
 386             ExprKind::Loop(body, label, ..) => {
 387                 let loop_begin = self.expr_index + 1;
 388                 self.label_stack.push((label, loop_begin));
 389                 if body.stmts.is_empty() && body.expr.is_none() {
 390                     // For empty loops we won't have updated self.expr_index after visiting the
 391                     // body, meaning we'd get an edge from expr_index to expr_index + 1, but
 392                     // instead we want an edge from expr_index + 1 to expr_index + 1.
 393                     self.drop_ranges.add_control_edge(loop_begin, loop_begin);
 394                 } else {
 395                     self.visit_block(body);
 396                     self.drop_ranges.add_control_edge(self.expr_index, loop_begin);
 397                 }
 398                 self.label_stack.pop();
 399             }
 400             // Find the loop entry by searching through the label stack for either the last entry
 401             // (if label is none), or the first entry where the label matches this one. The Loop
 402             // case maintains this stack mapping labels to the PostOrderId for the loop entry.
 403             ExprKind::Continue(hir::Destination { label, .. }, ..) => self
 404                 .label_stack
 405                 .iter()
 406                 .rev()
 407                 .find(|(loop_label, _)| label.is_none() || *loop_label == label)
 408                 .map_or((), |(_, target)| {
 409                     self.drop_ranges.add_control_edge(self.expr_index, *target)
 410                 }),
 411
 412             ExprKind::Break(destination, ..) => {
 413                 // destination either points to an expression or to a block. We use
 414                 // find_target_expression_from_destination to use the last expression of the block
 415                 // if destination points to a block.
 416                 //
 417                 // We add an edge to the hir_id of the expression/block we are breaking out of, and
 418                 // then in process_deferred_edges we will map this hir_id to its PostOrderId, which
 419                 // will refer to the end of the block due to the post order traversal.
 420                 self.find_target_expression_from_destination(destination).map_or((), |target| {
 421                     self.drop_ranges.add_control_edge_hir_id(self.expr_index, target)
 422                 })
 423             }
 424
 425             ExprKind::Call(f, args) => {
 426                 self.visit_expr(f);
 427                 for arg in args {
 428                     self.visit_expr(arg);
 429                 }
 430
 431                 self.handle_uninhabited_return(expr);
 432             }
 433             ExprKind::MethodCall(_, exprs, _) => {
 434                 for expr in exprs {
 435                     self.visit_expr(expr);
 436                 }
 437
 438                 self.handle_uninhabited_return(expr);
 439             }
 440
 441             ExprKind::AddrOf(..)
 442             | ExprKind::Array(..)
 443             | ExprKind::AssignOp(..)
 444             | ExprKind::Binary(..)
 445             | ExprKind::Block(..)
 446             | ExprKind::Box(..)
 447             | ExprKind::Cast(..)
 448             | ExprKind::Closure(..)
 449             | ExprKind::ConstBlock(..)
 450             | ExprKind::DropTemps(..)
 451             | ExprKind::Err
 452             | ExprKind::Field(..)
 453             | ExprKind::Index(..)
 454             | ExprKind::InlineAsm(..)
 455             | ExprKind::Let(..)
 456             | ExprKind::Lit(..)
 457             | ExprKind::Path(..)
 458             | ExprKind::Repeat(..)
 459             | ExprKind::Ret(..)
 460             | ExprKind::Struct(..)
 461             | ExprKind::Tup(..)
 462             | ExprKind::Type(..)
 463             | ExprKind::Unary(..)
 464             | ExprKind::Yield(..) => intravisit::walk_expr(self, expr),
 465         }
 466
 467         self.expr_index = self.expr_index + 1;
 468         self.drop_ranges.add_node_mapping(expr.hir_id, self.expr_index);
 469         self.consume_expr(expr);
 470         if let Some(expr) = reinit {
 471             self.reinit_expr(expr);
 472         }
 473     }
 474
 475     fn visit_pat(&mut self, pat: &'tcx hir::Pat<'tcx>) {
 476         intravisit::walk_pat(self, pat);
 477
 478         // Increment expr_count here to match what InteriorVisitor expects.
 479         self.expr_index = self.expr_index + 1;
 480     }
 481 }
 482
 483 impl DropRangesBuilder {
 484     fn new(
 485         tracked_values: impl Iterator<Item = TrackedValue>,
 486         hir: Map<'_>,
 487         num_exprs: usize,
 488     ) -> Self {
 489         let mut tracked_value_map = FxHashMap::<_, TrackedValueIndex>::default();
 490         let mut next = <_>::from(0u32);
 491         for value in tracked_values {
 492             for_each_consumable(hir, value, |value| {
 493                 if !tracked_value_map.contains_key(&value) {
 494                     tracked_value_map.insert(value, next);
 495                     next = next + 1;
 496                 }
 497             });
 498         }
 499         debug!("hir_id_map: {:?}", tracked_value_map);
 500         let num_values = tracked_value_map.len();
 501         Self {
 502             tracked_value_map,
 503             nodes: IndexVec::from_fn_n(|_| NodeInfo::new(num_values), num_exprs + 1),
 504             deferred_edges: <_>::default(),
 505             post_order_map: <_>::default(),
 506         }
 507     }
 508
 509     fn tracked_value_index(&self, tracked_value: TrackedValue) -> TrackedValueIndex {
 510         *self.tracked_value_map.get(&tracked_value).unwrap()
 511     }
 512
 513     /// Adds an entry in the mapping from HirIds to PostOrderIds
 514     ///
 515     /// Needed so that `add_control_edge_hir_id` can work.
 516     fn add_node_mapping(&mut self, node_hir_id: HirId, post_order_id: PostOrderId) {
 517         self.post_order_map.insert(node_hir_id, post_order_id);
 518     }
 519
 520     /// Like add_control_edge, but uses a hir_id as the target.
 521     ///
 522     /// This can be used for branches where we do not know the PostOrderId of the target yet,
 523     /// such as when handling `break` or `continue`.
 524     fn add_control_edge_hir_id(&mut self, from: PostOrderId, to: HirId) {
 525         self.deferred_edges.push((from, to));
 526     }
 527
 528     fn drop_at(&mut self, value: TrackedValue, location: PostOrderId) {
 529         let value = self.tracked_value_index(value);
 530         self.node_mut(location.into()).drops.push(value);
 531     }
 532
 533     fn reinit_at(&mut self, value: TrackedValue, location: PostOrderId) {
 534         let value = match self.tracked_value_map.get(&value) {
 535             Some(value) => *value,
 536             // If there's no value, this is never consumed and therefore is never dropped. We can
 537             // ignore this.
 538             None => return,
 539         };
 540         self.node_mut(location.into()).reinits.push(value);
 541     }
 542
 543     /// Looks up PostOrderId for any control edges added by HirId and adds a proper edge for them.
 544     ///
 545     /// Should be called after visiting the HIR but before solving the control flow, otherwise some
 546     /// edges will be missed.
 547     fn process_deferred_edges(&mut self) {
 548         trace!("processing deferred edges. post_order_map={:#?}", self.post_order_map);
 549         let mut edges = vec![];
 550         swap(&mut edges, &mut self.deferred_edges);
 551         edges.into_iter().for_each(|(from, to)| {
 552             trace!("Adding deferred edge from {:?} to {:?}", from, to);
 553             let to = *self.post_order_map.get(&to).expect("Expression ID not found");
 554             trace!("target edge PostOrderId={:?}", to);
 555             self.add_control_edge(from, to)
 556         });
 557     }
 558 }