1 // Copyright 2012-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.
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.
11 //! An analysis to determine which locals require allocas and
14 use rustc_data_structures::bitvec::BitVector;
15 use rustc_data_structures::indexed_vec::{Idx, IndexVec};
16 use rustc::middle::const_val::ConstVal;
17 use rustc::mir::{self, Location, TerminatorKind, Literal};
18 use rustc::mir::visit::{Visitor, LvalueContext};
19 use rustc::mir::traversal;
21 use super::MirContext;
23 pub fn lvalue_locals<'a, 'tcx>(mircx: &MirContext<'a, 'tcx>) -> BitVector {
25 let mut analyzer = LocalAnalyzer::new(mircx);
27 analyzer.visit_mir(mir);
29 for (index, ty) in mir.local_decls.iter().map(|l| l.ty).enumerate() {
30 let ty = mircx.monomorphize(&ty);
31 debug!("local {} has type {:?}", index, ty);
36 common::type_is_zero_size(mircx.ccx, ty)
38 // These sorts of types are immediates that we can store
39 // in an ValueRef without an alloca.
40 assert!(common::type_is_immediate(mircx.ccx, ty) ||
41 common::type_is_fat_ptr(mircx.ccx, ty));
42 } else if common::type_is_imm_pair(mircx.ccx, ty) {
43 // We allow pairs and uses of any of their 2 fields.
45 // These sorts of types require an alloca. Note that
46 // type_is_immediate() may *still* be true, particularly
47 // for newtypes, but we currently force some types
48 // (e.g. structs) into an alloca unconditionally, just so
49 // that we don't have to deal with having two pathways
50 // (gep vs extractvalue etc).
51 analyzer.mark_as_lvalue(mir::Local::new(index));
55 analyzer.lvalue_locals
58 struct LocalAnalyzer<'mir, 'a: 'mir, 'tcx: 'a> {
59 cx: &'mir MirContext<'a, 'tcx>,
60 lvalue_locals: BitVector,
61 seen_assigned: BitVector
64 impl<'mir, 'a, 'tcx> LocalAnalyzer<'mir, 'a, 'tcx> {
65 fn new(mircx: &'mir MirContext<'a, 'tcx>) -> LocalAnalyzer<'mir, 'a, 'tcx> {
68 lvalue_locals: BitVector::new(mircx.mir.local_decls.len()),
69 seen_assigned: BitVector::new(mircx.mir.local_decls.len())
73 fn mark_as_lvalue(&mut self, local: mir::Local) {
74 debug!("marking {:?} as lvalue", local);
75 self.lvalue_locals.insert(local.index());
78 fn mark_assigned(&mut self, local: mir::Local) {
79 if !self.seen_assigned.insert(local.index()) {
80 self.mark_as_lvalue(local);
85 impl<'mir, 'a, 'tcx> Visitor<'tcx> for LocalAnalyzer<'mir, 'a, 'tcx> {
86 fn visit_assign(&mut self,
87 block: mir::BasicBlock,
88 lvalue: &mir::Lvalue<'tcx>,
89 rvalue: &mir::Rvalue<'tcx>,
91 debug!("visit_assign(block={:?}, lvalue={:?}, rvalue={:?})", block, lvalue, rvalue);
93 if let mir::Lvalue::Local(index) = *lvalue {
94 self.mark_assigned(index);
95 if !self.cx.rvalue_creates_operand(rvalue) {
96 self.mark_as_lvalue(index);
99 self.visit_lvalue(lvalue, LvalueContext::Store, location);
102 self.visit_rvalue(rvalue, location);
105 fn visit_terminator_kind(&mut self,
106 block: mir::BasicBlock,
107 kind: &mir::TerminatorKind<'tcx>,
108 location: Location) {
110 mir::TerminatorKind::Call {
111 func: mir::Operand::Constant(mir::Constant {
112 literal: Literal::Value {
113 value: ConstVal::Function(def_id, _), ..
117 } if Some(def_id) == self.cx.ccx.tcx().lang_items.box_free_fn() => {
118 // box_free(x) shares with `drop x` the property that it
119 // is not guaranteed to be statically dominated by the
120 // definition of x, so x must always be in an alloca.
121 if let mir::Operand::Consume(ref lvalue) = args[0] {
122 self.visit_lvalue(lvalue, LvalueContext::Drop, location);
128 self.super_terminator_kind(block, kind, location);
131 fn visit_lvalue(&mut self,
132 lvalue: &mir::Lvalue<'tcx>,
133 context: LvalueContext<'tcx>,
134 location: Location) {
135 debug!("visit_lvalue(lvalue={:?}, context={:?})", lvalue, context);
137 // Allow uses of projections of immediate pair fields.
138 if let mir::Lvalue::Projection(ref proj) = *lvalue {
139 if let mir::Lvalue::Local(_) = proj.base {
140 let ty = proj.base.ty(self.cx.mir, self.cx.ccx.tcx());
142 let ty = self.cx.monomorphize(&ty.to_ty(self.cx.ccx.tcx()));
143 if common::type_is_imm_pair(self.cx.ccx, ty) {
144 if let mir::ProjectionElem::Field(..) = proj.elem {
145 if let LvalueContext::Consume = context {
153 if let mir::Lvalue::Local(index) = *lvalue {
155 LvalueContext::Call => {
156 self.mark_assigned(index);
159 LvalueContext::StorageLive |
160 LvalueContext::StorageDead |
161 LvalueContext::Inspect |
162 LvalueContext::Consume => {}
164 LvalueContext::Store |
165 LvalueContext::Borrow { .. } |
166 LvalueContext::Projection(..) => {
167 self.mark_as_lvalue(index);
170 LvalueContext::Drop => {
171 let ty = lvalue.ty(self.cx.mir, self.cx.ccx.tcx());
172 let ty = self.cx.monomorphize(&ty.to_ty(self.cx.ccx.tcx()));
174 // Only need the lvalue if we're actually dropping it.
175 if self.cx.ccx.shared().type_needs_drop(ty) {
176 self.mark_as_lvalue(index);
182 // A deref projection only reads the pointer, never needs the lvalue.
183 if let mir::Lvalue::Projection(ref proj) = *lvalue {
184 if let mir::ProjectionElem::Deref = proj.elem {
185 return self.visit_lvalue(&proj.base, LvalueContext::Consume, location);
189 self.super_lvalue(lvalue, context, location);
193 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
194 pub enum CleanupKind {
197 Internal { funclet: mir::BasicBlock }
200 pub fn cleanup_kinds<'a, 'tcx>(mir: &mir::Mir<'tcx>) -> IndexVec<mir::BasicBlock, CleanupKind> {
201 fn discover_masters<'tcx>(result: &mut IndexVec<mir::BasicBlock, CleanupKind>,
202 mir: &mir::Mir<'tcx>) {
203 for (bb, data) in mir.basic_blocks().iter_enumerated() {
204 match data.terminator().kind {
205 TerminatorKind::Goto { .. } |
206 TerminatorKind::Resume |
207 TerminatorKind::Return |
208 TerminatorKind::Unreachable |
209 TerminatorKind::SwitchInt { .. } => {
212 TerminatorKind::Call { cleanup: unwind, .. } |
213 TerminatorKind::Assert { cleanup: unwind, .. } |
214 TerminatorKind::DropAndReplace { unwind, .. } |
215 TerminatorKind::Drop { unwind, .. } => {
216 if let Some(unwind) = unwind {
217 debug!("cleanup_kinds: {:?}/{:?} registering {:?} as funclet",
219 result[unwind] = CleanupKind::Funclet;
226 fn propagate<'tcx>(result: &mut IndexVec<mir::BasicBlock, CleanupKind>,
227 mir: &mir::Mir<'tcx>) {
228 let mut funclet_succs = IndexVec::from_elem(None, mir.basic_blocks());
230 let mut set_successor = |funclet: mir::BasicBlock, succ| {
231 match funclet_succs[funclet] {
232 ref mut s @ None => {
233 debug!("set_successor: updating successor of {:?} to {:?}",
237 Some(s) => if s != succ {
238 span_bug!(mir.span, "funclet {:?} has 2 parents - {:?} and {:?}",
244 for (bb, data) in traversal::reverse_postorder(mir) {
245 let funclet = match result[bb] {
246 CleanupKind::NotCleanup => continue,
247 CleanupKind::Funclet => bb,
248 CleanupKind::Internal { funclet } => funclet,
251 debug!("cleanup_kinds: {:?}/{:?}/{:?} propagating funclet {:?}",
252 bb, data, result[bb], funclet);
254 for &succ in data.terminator().successors().iter() {
255 let kind = result[succ];
256 debug!("cleanup_kinds: propagating {:?} to {:?}/{:?}",
257 funclet, succ, kind);
259 CleanupKind::NotCleanup => {
260 result[succ] = CleanupKind::Internal { funclet: funclet };
262 CleanupKind::Funclet => {
263 set_successor(funclet, succ);
265 CleanupKind::Internal { funclet: succ_funclet } => {
266 if funclet != succ_funclet {
267 // `succ` has 2 different funclet going into it, so it must
268 // be a funclet by itself.
270 debug!("promoting {:?} to a funclet and updating {:?}", succ,
272 result[succ] = CleanupKind::Funclet;
273 set_successor(succ_funclet, succ);
274 set_successor(funclet, succ);
282 let mut result = IndexVec::from_elem(CleanupKind::NotCleanup, mir.basic_blocks());
284 discover_masters(&mut result, mir);
285 propagate(&mut result, mir);
286 debug!("cleanup_kinds: result={:?}", result);