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.
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 use graphviz::IntoCow;
12 use middle::const_val::ConstVal;
13 use rustc_const_math::{ConstUsize, ConstInt, ConstMathErr};
14 use rustc_data_structures::indexed_vec::{IndexVec, Idx};
15 use rustc_data_structures::control_flow_graph::dominators::{Dominators, dominators};
16 use rustc_data_structures::control_flow_graph::{GraphPredecessors, GraphSuccessors};
17 use rustc_data_structures::control_flow_graph::ControlFlowGraph;
18 use hir::def::CtorKind;
19 use hir::def_id::DefId;
20 use ty::subst::{Subst, Substs};
21 use ty::{self, AdtDef, ClosureSubsts, Region, Ty};
22 use ty::fold::{TypeFoldable, TypeFolder, TypeVisitor};
24 use rustc_back::slice;
27 use std::borrow::{Cow};
29 use std::fmt::{self, Debug, Formatter, Write};
31 use std::ops::{Index, IndexMut};
32 use std::vec::IntoIter;
33 use syntax::ast::Name;
42 macro_rules! newtype_index {
43 ($name:ident, $debug_name:expr) => (
44 #[derive(Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord,
45 RustcEncodable, RustcDecodable)]
46 pub struct $name(u32);
49 fn new(value: usize) -> Self {
50 assert!(value < (u32::MAX) as usize);
53 fn index(self) -> usize {
58 impl Debug for $name {
59 fn fmt(&self, fmt: &mut Formatter) -> fmt::Result {
60 write!(fmt, "{}{}", $debug_name, self.0)
66 /// Lowered representation of a single function.
67 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
68 pub struct Mir<'tcx> {
69 /// List of basic blocks. References to basic block use a newtyped index type `BasicBlock`
70 /// that indexes into this vector.
71 basic_blocks: IndexVec<BasicBlock, BasicBlockData<'tcx>>,
73 /// List of visibility (lexical) scopes; these are referenced by statements
74 /// and used (eventually) for debuginfo. Indexed by a `VisibilityScope`.
75 pub visibility_scopes: IndexVec<VisibilityScope, VisibilityScopeData>,
77 /// Rvalues promoted from this function, such as borrows of constants.
78 /// Each of them is the Mir of a constant with the fn's type parameters
79 /// in scope, but a separate set of locals.
80 pub promoted: IndexVec<Promoted, Mir<'tcx>>,
82 /// Return type of the function.
83 pub return_ty: Ty<'tcx>,
85 /// Declarations of locals.
87 /// The first local is the return value pointer, followed by `arg_count`
88 /// locals for the function arguments, followed by any user-declared
89 /// variables and temporaries.
90 pub local_decls: IndexVec<Local, LocalDecl<'tcx>>,
92 /// Number of arguments this function takes.
94 /// Starting at local 1, `arg_count` locals will be provided by the caller
95 /// and can be assumed to be initialized.
97 /// If this MIR was built for a constant, this will be 0.
100 /// Names and capture modes of all the closure upvars, assuming
101 /// the first argument is either the closure or a reference to it.
102 pub upvar_decls: Vec<UpvarDecl>,
104 /// Mark an argument local (which must be a tuple) as getting passed as
105 /// its individual components at the LLVM level.
107 /// This is used for the "rust-call" ABI.
108 pub spread_arg: Option<Local>,
110 /// A span representing this MIR, for error reporting
113 /// A cache for various calculations
117 /// where execution begins
118 pub const START_BLOCK: BasicBlock = BasicBlock(0);
120 impl<'tcx> Mir<'tcx> {
121 pub fn new(basic_blocks: IndexVec<BasicBlock, BasicBlockData<'tcx>>,
122 visibility_scopes: IndexVec<VisibilityScope, VisibilityScopeData>,
123 promoted: IndexVec<Promoted, Mir<'tcx>>,
125 local_decls: IndexVec<Local, LocalDecl<'tcx>>,
127 upvar_decls: Vec<UpvarDecl>,
130 // We need `arg_count` locals, and one for the return pointer
131 assert!(local_decls.len() >= arg_count + 1,
132 "expected at least {} locals, got {}", arg_count + 1, local_decls.len());
133 assert_eq!(local_decls[RETURN_POINTER].ty, return_ty);
136 basic_blocks: basic_blocks,
137 visibility_scopes: visibility_scopes,
139 return_ty: return_ty,
140 local_decls: local_decls,
141 arg_count: arg_count,
142 upvar_decls: upvar_decls,
145 cache: cache::Cache::new()
150 pub fn basic_blocks(&self) -> &IndexVec<BasicBlock, BasicBlockData<'tcx>> {
155 pub fn basic_blocks_mut(&mut self) -> &mut IndexVec<BasicBlock, BasicBlockData<'tcx>> {
156 self.cache.invalidate();
157 &mut self.basic_blocks
161 pub fn predecessors(&self) -> Ref<IndexVec<BasicBlock, Vec<BasicBlock>>> {
162 self.cache.predecessors(self)
166 pub fn predecessors_for(&self, bb: BasicBlock) -> Ref<Vec<BasicBlock>> {
167 Ref::map(self.predecessors(), |p| &p[bb])
171 pub fn dominators(&self) -> Dominators<BasicBlock> {
176 pub fn local_kind(&self, local: Local) -> LocalKind {
177 let index = local.0 as usize;
179 debug_assert!(self.local_decls[local].mutability == Mutability::Mut,
180 "return pointer should be mutable");
182 LocalKind::ReturnPointer
183 } else if index < self.arg_count + 1 {
185 } else if self.local_decls[local].name.is_some() {
188 debug_assert!(self.local_decls[local].mutability == Mutability::Mut,
189 "temp should be mutable");
195 /// Returns an iterator over all temporaries.
197 pub fn temps_iter<'a>(&'a self) -> impl Iterator<Item=Local> + 'a {
198 (self.arg_count+1..self.local_decls.len()).filter_map(move |index| {
199 let local = Local::new(index);
200 if self.local_decls[local].source_info.is_none() {
208 /// Returns an iterator over all user-declared locals.
210 pub fn vars_iter<'a>(&'a self) -> impl Iterator<Item=Local> + 'a {
211 (self.arg_count+1..self.local_decls.len()).filter_map(move |index| {
212 let local = Local::new(index);
213 if self.local_decls[local].source_info.is_none() {
221 /// Returns an iterator over all function arguments.
223 pub fn args_iter(&self) -> impl Iterator<Item=Local> {
224 let arg_count = self.arg_count;
225 (1..arg_count+1).map(Local::new)
228 /// Returns an iterator over all user-defined variables and compiler-generated temporaries (all
229 /// locals that are neither arguments nor the return pointer).
231 pub fn vars_and_temps_iter(&self) -> impl Iterator<Item=Local> {
232 let arg_count = self.arg_count;
233 let local_count = self.local_decls.len();
234 (arg_count+1..local_count).map(Local::new)
237 /// Changes a statement to a nop. This is both faster than deleting instructions and avoids
238 /// invalidating statement indices in `Location`s.
239 pub fn make_statement_nop(&mut self, location: Location) {
240 let block = &mut self[location.block];
241 debug_assert!(location.statement_index < block.statements.len());
242 block.statements[location.statement_index].make_nop()
246 impl<'tcx> Index<BasicBlock> for Mir<'tcx> {
247 type Output = BasicBlockData<'tcx>;
250 fn index(&self, index: BasicBlock) -> &BasicBlockData<'tcx> {
251 &self.basic_blocks()[index]
255 impl<'tcx> IndexMut<BasicBlock> for Mir<'tcx> {
257 fn index_mut(&mut self, index: BasicBlock) -> &mut BasicBlockData<'tcx> {
258 &mut self.basic_blocks_mut()[index]
262 /// Grouped information about the source code origin of a MIR entity.
263 /// Intended to be inspected by diagnostics and debuginfo.
264 /// Most passes can work with it as a whole, within a single function.
265 #[derive(Copy, Clone, Debug, PartialEq, Eq, RustcEncodable, RustcDecodable)]
266 pub struct SourceInfo {
267 /// Source span for the AST pertaining to this MIR entity.
270 /// The lexical visibility scope, i.e. which bindings can be seen.
271 pub scope: VisibilityScope
274 ///////////////////////////////////////////////////////////////////////////
275 // Mutability and borrow kinds
277 #[derive(Copy, Clone, Debug, PartialEq, Eq, RustcEncodable, RustcDecodable)]
278 pub enum Mutability {
283 #[derive(Copy, Clone, Debug, PartialEq, Eq, RustcEncodable, RustcDecodable)]
284 pub enum BorrowKind {
285 /// Data must be immutable and is aliasable.
288 /// Data must be immutable but not aliasable. This kind of borrow
289 /// cannot currently be expressed by the user and is used only in
290 /// implicit closure bindings. It is needed when you the closure
291 /// is borrowing or mutating a mutable referent, e.g.:
293 /// let x: &mut isize = ...;
294 /// let y = || *x += 5;
296 /// If we were to try to translate this closure into a more explicit
297 /// form, we'd encounter an error with the code as written:
299 /// struct Env { x: & &mut isize }
300 /// let x: &mut isize = ...;
301 /// let y = (&mut Env { &x }, fn_ptr); // Closure is pair of env and fn
302 /// fn fn_ptr(env: &mut Env) { **env.x += 5; }
304 /// This is then illegal because you cannot mutate a `&mut` found
305 /// in an aliasable location. To solve, you'd have to translate with
306 /// an `&mut` borrow:
308 /// struct Env { x: & &mut isize }
309 /// let x: &mut isize = ...;
310 /// let y = (&mut Env { &mut x }, fn_ptr); // changed from &x to &mut x
311 /// fn fn_ptr(env: &mut Env) { **env.x += 5; }
313 /// Now the assignment to `**env.x` is legal, but creating a
314 /// mutable pointer to `x` is not because `x` is not mutable. We
315 /// could fix this by declaring `x` as `let mut x`. This is ok in
316 /// user code, if awkward, but extra weird for closures, since the
317 /// borrow is hidden.
319 /// So we introduce a "unique imm" borrow -- the referent is
320 /// immutable, but not aliasable. This solves the problem. For
321 /// simplicity, we don't give users the way to express this
322 /// borrow, it's just used when translating closures.
325 /// Data is mutable and not aliasable.
329 ///////////////////////////////////////////////////////////////////////////
330 // Variables and temps
332 newtype_index!(Local, "_");
334 pub const RETURN_POINTER: Local = Local(0);
336 /// Classifies locals into categories. See `Mir::local_kind`.
337 #[derive(PartialEq, Eq, Debug)]
339 /// User-declared variable binding
341 /// Compiler-introduced temporary
343 /// Function argument
345 /// Location of function's return value
351 /// This can be a binding declared by the user, a temporary inserted by the compiler, a function
352 /// argument, or the return pointer.
353 #[derive(Clone, Debug, RustcEncodable, RustcDecodable)]
354 pub struct LocalDecl<'tcx> {
355 /// `let mut x` vs `let x`.
357 /// Temporaries and the return pointer are always mutable.
358 pub mutability: Mutability,
360 /// Type of this local.
363 /// Name of the local, used in debuginfo and pretty-printing.
365 /// Note that function arguments can also have this set to `Some(_)`
366 /// to generate better debuginfo.
367 pub name: Option<Name>,
369 /// For user-declared variables, stores their source information.
371 /// For temporaries, this is `None`.
373 /// This is the primary way to differentiate between user-declared
374 /// variables and compiler-generated temporaries.
375 pub source_info: Option<SourceInfo>,
378 impl<'tcx> LocalDecl<'tcx> {
379 /// Create a new `LocalDecl` for a temporary.
381 pub fn new_temp(ty: Ty<'tcx>) -> Self {
383 mutability: Mutability::Mut,
390 /// Builds a `LocalDecl` for the return pointer.
392 /// This must be inserted into the `local_decls` list as the first local.
394 pub fn new_return_pointer(return_ty: Ty) -> LocalDecl {
396 mutability: Mutability::Mut,
399 name: None, // FIXME maybe we do want some name here?
404 /// A closure capture, with its name and mode.
405 #[derive(Clone, Debug, RustcEncodable, RustcDecodable)]
406 pub struct UpvarDecl {
407 pub debug_name: Name,
409 /// If true, the capture is behind a reference.
413 ///////////////////////////////////////////////////////////////////////////
416 newtype_index!(BasicBlock, "bb");
418 ///////////////////////////////////////////////////////////////////////////
419 // BasicBlockData and Terminator
421 #[derive(Clone, Debug, RustcEncodable, RustcDecodable)]
422 pub struct BasicBlockData<'tcx> {
423 /// List of statements in this block.
424 pub statements: Vec<Statement<'tcx>>,
426 /// Terminator for this block.
428 /// NB. This should generally ONLY be `None` during construction.
429 /// Therefore, you should generally access it via the
430 /// `terminator()` or `terminator_mut()` methods. The only
431 /// exception is that certain passes, such as `simplify_cfg`, swap
432 /// out the terminator temporarily with `None` while they continue
433 /// to recurse over the set of basic blocks.
434 pub terminator: Option<Terminator<'tcx>>,
436 /// If true, this block lies on an unwind path. This is used
437 /// during trans where distinct kinds of basic blocks may be
438 /// generated (particularly for MSVC cleanup). Unwind blocks must
439 /// only branch to other unwind blocks.
440 pub is_cleanup: bool,
443 #[derive(Clone, Debug, RustcEncodable, RustcDecodable)]
444 pub struct Terminator<'tcx> {
445 pub source_info: SourceInfo,
446 pub kind: TerminatorKind<'tcx>
449 #[derive(Clone, RustcEncodable, RustcDecodable)]
450 pub enum TerminatorKind<'tcx> {
451 /// block should have one successor in the graph; we jump there
456 /// operand evaluates to an integer; jump depending on its value
457 /// to one of the targets, and otherwise fallback to `otherwise`
459 /// discriminant value being tested
460 discr: Operand<'tcx>,
462 /// type of value being tested
465 /// Possible values. The locations to branch to in each case
466 /// are found in the corresponding indices from the `targets` vector.
467 values: Cow<'tcx, [ConstInt]>,
469 /// Possible branch sites. The last element of this vector is used
470 /// for the otherwise branch, so targets.len() == values.len() + 1
472 // This invariant is quite non-obvious and also could be improved.
473 // One way to make this invariant is to have something like this instead:
475 // branches: Vec<(ConstInt, BasicBlock)>,
476 // otherwise: Option<BasicBlock> // exhaustive if None
478 // However we’ve decided to keep this as-is until we figure a case
479 // where some other approach seems to be strictly better than other.
480 targets: Vec<BasicBlock>,
483 /// Indicates that the landing pad is finished and unwinding should
484 /// continue. Emitted by build::scope::diverge_cleanup.
487 /// Indicates a normal return. The return pointer lvalue should
488 /// have been filled in by now. This should occur at most once.
491 /// Indicates a terminator that can never be reached.
496 location: Lvalue<'tcx>,
498 unwind: Option<BasicBlock>
501 /// Drop the Lvalue and assign the new value over it
503 location: Lvalue<'tcx>,
504 value: Operand<'tcx>,
506 unwind: Option<BasicBlock>,
509 /// Block ends with a call of a converging function
511 /// The function that’s being called
513 /// Arguments the function is called with
514 args: Vec<Operand<'tcx>>,
515 /// Destination for the return value. If some, the call is converging.
516 destination: Option<(Lvalue<'tcx>, BasicBlock)>,
517 /// Cleanups to be done if the call unwinds.
518 cleanup: Option<BasicBlock>
521 /// Jump to the target if the condition has the expected value,
522 /// otherwise panic with a message and a cleanup target.
526 msg: AssertMessage<'tcx>,
528 cleanup: Option<BasicBlock>
532 impl<'tcx> Terminator<'tcx> {
533 pub fn successors(&self) -> Cow<[BasicBlock]> {
534 self.kind.successors()
537 pub fn successors_mut(&mut self) -> Vec<&mut BasicBlock> {
538 self.kind.successors_mut()
542 impl<'tcx> TerminatorKind<'tcx> {
543 pub fn if_<'a, 'gcx>(tcx: ty::TyCtxt<'a, 'gcx, 'tcx>, cond: Operand<'tcx>,
544 t: BasicBlock, f: BasicBlock) -> TerminatorKind<'tcx> {
545 static BOOL_SWITCH_FALSE: &'static [ConstInt] = &[ConstInt::U8(0)];
546 TerminatorKind::SwitchInt {
548 switch_ty: tcx.types.bool,
549 values: From::from(BOOL_SWITCH_FALSE),
554 pub fn successors(&self) -> Cow<[BasicBlock]> {
555 use self::TerminatorKind::*;
557 Goto { target: ref b } => slice::ref_slice(b).into_cow(),
558 SwitchInt { targets: ref b, .. } => b[..].into_cow(),
559 Resume => (&[]).into_cow(),
560 Return => (&[]).into_cow(),
561 Unreachable => (&[]).into_cow(),
562 Call { destination: Some((_, t)), cleanup: Some(c), .. } => vec![t, c].into_cow(),
563 Call { destination: Some((_, ref t)), cleanup: None, .. } =>
564 slice::ref_slice(t).into_cow(),
565 Call { destination: None, cleanup: Some(ref c), .. } => slice::ref_slice(c).into_cow(),
566 Call { destination: None, cleanup: None, .. } => (&[]).into_cow(),
567 DropAndReplace { target, unwind: Some(unwind), .. } |
568 Drop { target, unwind: Some(unwind), .. } => {
569 vec![target, unwind].into_cow()
571 DropAndReplace { ref target, unwind: None, .. } |
572 Drop { ref target, unwind: None, .. } => {
573 slice::ref_slice(target).into_cow()
575 Assert { target, cleanup: Some(unwind), .. } => vec![target, unwind].into_cow(),
576 Assert { ref target, .. } => slice::ref_slice(target).into_cow(),
580 // FIXME: no mootable cow. I’m honestly not sure what a “cow” between `&mut [BasicBlock]` and
581 // `Vec<&mut BasicBlock>` would look like in the first place.
582 pub fn successors_mut(&mut self) -> Vec<&mut BasicBlock> {
583 use self::TerminatorKind::*;
585 Goto { target: ref mut b } => vec![b],
586 SwitchInt { targets: ref mut b, .. } => b.iter_mut().collect(),
587 Resume => Vec::new(),
588 Return => Vec::new(),
589 Unreachable => Vec::new(),
590 Call { destination: Some((_, ref mut t)), cleanup: Some(ref mut c), .. } => vec![t, c],
591 Call { destination: Some((_, ref mut t)), cleanup: None, .. } => vec![t],
592 Call { destination: None, cleanup: Some(ref mut c), .. } => vec![c],
593 Call { destination: None, cleanup: None, .. } => vec![],
594 DropAndReplace { ref mut target, unwind: Some(ref mut unwind), .. } |
595 Drop { ref mut target, unwind: Some(ref mut unwind), .. } => vec![target, unwind],
596 DropAndReplace { ref mut target, unwind: None, .. } |
597 Drop { ref mut target, unwind: None, .. } => {
600 Assert { ref mut target, cleanup: Some(ref mut unwind), .. } => vec![target, unwind],
601 Assert { ref mut target, .. } => vec![target]
606 impl<'tcx> BasicBlockData<'tcx> {
607 pub fn new(terminator: Option<Terminator<'tcx>>) -> BasicBlockData<'tcx> {
610 terminator: terminator,
615 /// Accessor for terminator.
617 /// Terminator may not be None after construction of the basic block is complete. This accessor
618 /// provides a convenience way to reach the terminator.
619 pub fn terminator(&self) -> &Terminator<'tcx> {
620 self.terminator.as_ref().expect("invalid terminator state")
623 pub fn terminator_mut(&mut self) -> &mut Terminator<'tcx> {
624 self.terminator.as_mut().expect("invalid terminator state")
628 impl<'tcx> Debug for TerminatorKind<'tcx> {
629 fn fmt(&self, fmt: &mut Formatter) -> fmt::Result {
631 let successors = self.successors();
632 let labels = self.fmt_successor_labels();
633 assert_eq!(successors.len(), labels.len());
635 match successors.len() {
638 1 => write!(fmt, " -> {:?}", successors[0]),
641 write!(fmt, " -> [")?;
642 for (i, target) in successors.iter().enumerate() {
646 write!(fmt, "{}: {:?}", labels[i], target)?;
655 impl<'tcx> TerminatorKind<'tcx> {
656 /// Write the "head" part of the terminator; that is, its name and the data it uses to pick the
657 /// successor basic block, if any. The only information not inlcuded is the list of possible
658 /// successors, which may be rendered differently between the text and the graphviz format.
659 pub fn fmt_head<W: Write>(&self, fmt: &mut W) -> fmt::Result {
660 use self::TerminatorKind::*;
662 Goto { .. } => write!(fmt, "goto"),
663 SwitchInt { discr: ref lv, .. } => write!(fmt, "switchInt({:?})", lv),
664 Return => write!(fmt, "return"),
665 Resume => write!(fmt, "resume"),
666 Unreachable => write!(fmt, "unreachable"),
667 Drop { ref location, .. } => write!(fmt, "drop({:?})", location),
668 DropAndReplace { ref location, ref value, .. } =>
669 write!(fmt, "replace({:?} <- {:?})", location, value),
670 Call { ref func, ref args, ref destination, .. } => {
671 if let Some((ref destination, _)) = *destination {
672 write!(fmt, "{:?} = ", destination)?;
674 write!(fmt, "{:?}(", func)?;
675 for (index, arg) in args.iter().enumerate() {
679 write!(fmt, "{:?}", arg)?;
683 Assert { ref cond, expected, ref msg, .. } => {
684 write!(fmt, "assert(")?;
688 write!(fmt, "{:?}, ", cond)?;
691 AssertMessage::BoundsCheck { ref len, ref index } => {
692 write!(fmt, "{:?}, {:?}, {:?}",
693 "index out of bounds: the len is {} but the index is {}",
696 AssertMessage::Math(ref err) => {
697 write!(fmt, "{:?}", err.description())?;
706 /// Return the list of labels for the edges to the successor basic blocks.
707 pub fn fmt_successor_labels(&self) -> Vec<Cow<'static, str>> {
708 use self::TerminatorKind::*;
710 Return | Resume | Unreachable => vec![],
711 Goto { .. } => vec!["".into()],
712 SwitchInt { ref values, .. } => {
715 let mut buf = String::new();
716 fmt_const_val(&mut buf, &ConstVal::Integral(*const_val)).unwrap();
719 .chain(iter::once(String::from("otherwise").into()))
722 Call { destination: Some(_), cleanup: Some(_), .. } =>
723 vec!["return".into_cow(), "unwind".into_cow()],
724 Call { destination: Some(_), cleanup: None, .. } => vec!["return".into_cow()],
725 Call { destination: None, cleanup: Some(_), .. } => vec!["unwind".into_cow()],
726 Call { destination: None, cleanup: None, .. } => vec![],
727 DropAndReplace { unwind: None, .. } |
728 Drop { unwind: None, .. } => vec!["return".into_cow()],
729 DropAndReplace { unwind: Some(_), .. } |
730 Drop { unwind: Some(_), .. } => {
731 vec!["return".into_cow(), "unwind".into_cow()]
733 Assert { cleanup: None, .. } => vec!["".into()],
735 vec!["success".into_cow(), "unwind".into_cow()]
740 #[derive(Clone, Debug, RustcEncodable, RustcDecodable)]
741 pub enum AssertMessage<'tcx> {
749 ///////////////////////////////////////////////////////////////////////////
752 #[derive(Clone, RustcEncodable, RustcDecodable)]
753 pub struct Statement<'tcx> {
754 pub source_info: SourceInfo,
755 pub kind: StatementKind<'tcx>,
758 impl<'tcx> Statement<'tcx> {
759 /// Changes a statement to a nop. This is both faster than deleting instructions and avoids
760 /// invalidating statement indices in `Location`s.
761 pub fn make_nop(&mut self) {
762 self.kind = StatementKind::Nop
766 #[derive(Clone, Debug, RustcEncodable, RustcDecodable)]
767 pub enum StatementKind<'tcx> {
768 /// Write the RHS Rvalue to the LHS Lvalue.
769 Assign(Lvalue<'tcx>, Rvalue<'tcx>),
771 /// Write the discriminant for a variant to the enum Lvalue.
772 SetDiscriminant { lvalue: Lvalue<'tcx>, variant_index: usize },
774 /// Start a live range for the storage of the local.
775 StorageLive(Lvalue<'tcx>),
777 /// End the current live range for the storage of the local.
778 StorageDead(Lvalue<'tcx>),
782 outputs: Vec<Lvalue<'tcx>>,
783 inputs: Vec<Operand<'tcx>>
786 /// No-op. Useful for deleting instructions without affecting statement indices.
790 impl<'tcx> Debug for Statement<'tcx> {
791 fn fmt(&self, fmt: &mut Formatter) -> fmt::Result {
792 use self::StatementKind::*;
794 Assign(ref lv, ref rv) => write!(fmt, "{:?} = {:?}", lv, rv),
795 StorageLive(ref lv) => write!(fmt, "StorageLive({:?})", lv),
796 StorageDead(ref lv) => write!(fmt, "StorageDead({:?})", lv),
797 SetDiscriminant{lvalue: ref lv, variant_index: index} => {
798 write!(fmt, "discriminant({:?}) = {:?}", lv, index)
800 InlineAsm { ref asm, ref outputs, ref inputs } => {
801 write!(fmt, "asm!({:?} : {:?} : {:?})", asm, outputs, inputs)
803 Nop => write!(fmt, "nop"),
808 ///////////////////////////////////////////////////////////////////////////
811 /// A path to a value; something that can be evaluated without
812 /// changing or disturbing program state.
813 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable)]
814 pub enum Lvalue<'tcx> {
818 /// static or static mut variable
819 Static(Box<Static<'tcx>>),
821 /// projection out of an lvalue (access a field, deref a pointer, etc)
822 Projection(Box<LvalueProjection<'tcx>>),
825 /// The def-id of a static, along with its normalized type (which is
826 /// stored to avoid requiring normalization when reading MIR).
827 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable)]
828 pub struct Static<'tcx> {
833 /// The `Projection` data structure defines things of the form `B.x`
834 /// or `*B` or `B[index]`. Note that it is parameterized because it is
835 /// shared between `Constant` and `Lvalue`. See the aliases
836 /// `LvalueProjection` etc below.
837 #[derive(Clone, Debug, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
838 pub struct Projection<'tcx, B, V> {
840 pub elem: ProjectionElem<'tcx, V>,
843 #[derive(Clone, Debug, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
844 pub enum ProjectionElem<'tcx, V> {
846 Field(Field, Ty<'tcx>),
849 /// These indices are generated by slice patterns. Easiest to explain
853 /// [X, _, .._, _, _] => { offset: 0, min_length: 4, from_end: false },
854 /// [_, X, .._, _, _] => { offset: 1, min_length: 4, from_end: false },
855 /// [_, _, .._, X, _] => { offset: 2, min_length: 4, from_end: true },
856 /// [_, _, .._, _, X] => { offset: 1, min_length: 4, from_end: true },
859 /// index or -index (in Python terms), depending on from_end
861 /// thing being indexed must be at least this long
863 /// counting backwards from end?
867 /// These indices are generated by slice patterns.
869 /// slice[from:-to] in Python terms.
875 /// "Downcast" to a variant of an ADT. Currently, we only introduce
876 /// this for ADTs with more than one variant. It may be better to
877 /// just introduce it always, or always for enums.
878 Downcast(&'tcx AdtDef, usize),
881 /// Alias for projections as they appear in lvalues, where the base is an lvalue
882 /// and the index is an operand.
883 pub type LvalueProjection<'tcx> = Projection<'tcx, Lvalue<'tcx>, Operand<'tcx>>;
885 /// Alias for projections as they appear in lvalues, where the base is an lvalue
886 /// and the index is an operand.
887 pub type LvalueElem<'tcx> = ProjectionElem<'tcx, Operand<'tcx>>;
889 newtype_index!(Field, "field");
891 impl<'tcx> Lvalue<'tcx> {
892 pub fn field(self, f: Field, ty: Ty<'tcx>) -> Lvalue<'tcx> {
893 self.elem(ProjectionElem::Field(f, ty))
896 pub fn deref(self) -> Lvalue<'tcx> {
897 self.elem(ProjectionElem::Deref)
900 pub fn downcast(self, adt_def: &'tcx AdtDef, variant_index: usize) -> Lvalue<'tcx> {
901 self.elem(ProjectionElem::Downcast(adt_def, variant_index))
904 pub fn index(self, index: Operand<'tcx>) -> Lvalue<'tcx> {
905 self.elem(ProjectionElem::Index(index))
908 pub fn elem(self, elem: LvalueElem<'tcx>) -> Lvalue<'tcx> {
909 Lvalue::Projection(Box::new(LvalueProjection {
916 impl<'tcx> Debug for Lvalue<'tcx> {
917 fn fmt(&self, fmt: &mut Formatter) -> fmt::Result {
921 Local(id) => write!(fmt, "{:?}", id),
922 Static(box self::Static { def_id, ty }) =>
923 write!(fmt, "({}: {:?})", ty::tls::with(|tcx| tcx.item_path_str(def_id)), ty),
924 Projection(ref data) =>
926 ProjectionElem::Downcast(ref adt_def, index) =>
927 write!(fmt, "({:?} as {})", data.base, adt_def.variants[index].name),
928 ProjectionElem::Deref =>
929 write!(fmt, "(*{:?})", data.base),
930 ProjectionElem::Field(field, ty) =>
931 write!(fmt, "({:?}.{:?}: {:?})", data.base, field.index(), ty),
932 ProjectionElem::Index(ref index) =>
933 write!(fmt, "{:?}[{:?}]", data.base, index),
934 ProjectionElem::ConstantIndex { offset, min_length, from_end: false } =>
935 write!(fmt, "{:?}[{:?} of {:?}]", data.base, offset, min_length),
936 ProjectionElem::ConstantIndex { offset, min_length, from_end: true } =>
937 write!(fmt, "{:?}[-{:?} of {:?}]", data.base, offset, min_length),
938 ProjectionElem::Subslice { from, to } if to == 0 =>
939 write!(fmt, "{:?}[{:?}:]", data.base, from),
940 ProjectionElem::Subslice { from, to } if from == 0 =>
941 write!(fmt, "{:?}[:-{:?}]", data.base, to),
942 ProjectionElem::Subslice { from, to } =>
943 write!(fmt, "{:?}[{:?}:-{:?}]", data.base,
951 ///////////////////////////////////////////////////////////////////////////
954 newtype_index!(VisibilityScope, "scope");
955 pub const ARGUMENT_VISIBILITY_SCOPE : VisibilityScope = VisibilityScope(0);
957 #[derive(Clone, Debug, RustcEncodable, RustcDecodable)]
958 pub struct VisibilityScopeData {
960 pub parent_scope: Option<VisibilityScope>,
963 ///////////////////////////////////////////////////////////////////////////
966 /// These are values that can appear inside an rvalue (or an index
967 /// lvalue). They are intentionally limited to prevent rvalues from
968 /// being nested in one another.
969 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable)]
970 pub enum Operand<'tcx> {
971 Consume(Lvalue<'tcx>),
972 Constant(Constant<'tcx>),
975 impl<'tcx> Debug for Operand<'tcx> {
976 fn fmt(&self, fmt: &mut Formatter) -> fmt::Result {
977 use self::Operand::*;
979 Constant(ref a) => write!(fmt, "{:?}", a),
980 Consume(ref lv) => write!(fmt, "{:?}", lv),
985 impl<'tcx> Operand<'tcx> {
986 pub fn function_handle<'a>(
987 tcx: ty::TyCtxt<'a, 'tcx, 'tcx>,
989 substs: &'tcx Substs<'tcx>,
992 Operand::Constant(Constant {
994 ty: tcx.item_type(def_id).subst(tcx, substs),
995 literal: Literal::Value { value: ConstVal::Function(def_id, substs) },
1001 ///////////////////////////////////////////////////////////////////////////
1004 #[derive(Clone, RustcEncodable, RustcDecodable)]
1005 pub enum Rvalue<'tcx> {
1006 /// x (either a move or copy, depending on type of x)
1010 Repeat(Operand<'tcx>, ConstUsize),
1013 Ref(&'tcx Region, BorrowKind, Lvalue<'tcx>),
1015 /// length of a [X] or [X;n] value
1018 Cast(CastKind, Operand<'tcx>, Ty<'tcx>),
1020 BinaryOp(BinOp, Operand<'tcx>, Operand<'tcx>),
1021 CheckedBinaryOp(BinOp, Operand<'tcx>, Operand<'tcx>),
1023 UnaryOp(UnOp, Operand<'tcx>),
1025 /// Read the discriminant of an ADT.
1027 /// Undefined (i.e. no effort is made to make it defined, but there’s no reason why it cannot
1028 /// be defined to return, say, a 0) if ADT is not an enum.
1029 Discriminant(Lvalue<'tcx>),
1031 /// Creates an *uninitialized* Box
1034 /// Create an aggregate value, like a tuple or struct. This is
1035 /// only needed because we want to distinguish `dest = Foo { x:
1036 /// ..., y: ... }` from `dest.x = ...; dest.y = ...;` in the case
1037 /// that `Foo` has a destructor. These rvalues can be optimized
1038 /// away after type-checking and before lowering.
1039 Aggregate(AggregateKind<'tcx>, Vec<Operand<'tcx>>),
1042 #[derive(Clone, Copy, Debug, PartialEq, Eq, RustcEncodable, RustcDecodable)]
1046 /// Convert unique, zero-sized type for a fn to fn()
1049 /// Convert non capturing closure to fn()
1052 /// Convert safe fn() to unsafe fn()
1055 /// "Unsize" -- convert a thin-or-fat pointer to a fat pointer.
1056 /// trans must figure out the details once full monomorphization
1057 /// is known. For example, this could be used to cast from a
1058 /// `&[i32;N]` to a `&[i32]`, or a `Box<T>` to a `Box<Trait>`
1059 /// (presuming `T: Trait`).
1063 #[derive(Clone, Debug, PartialEq, Eq, RustcEncodable, RustcDecodable)]
1064 pub enum AggregateKind<'tcx> {
1065 /// The type is of the element
1068 /// The second field is variant number (discriminant), it's equal to 0
1069 /// for struct and union expressions. The fourth field is active field
1070 /// number and is present only for union expressions.
1071 Adt(&'tcx AdtDef, usize, &'tcx Substs<'tcx>, Option<usize>),
1072 Closure(DefId, ClosureSubsts<'tcx>),
1075 #[derive(Copy, Clone, Debug, PartialEq, Eq, RustcEncodable, RustcDecodable)]
1077 /// The `+` operator (addition)
1079 /// The `-` operator (subtraction)
1081 /// The `*` operator (multiplication)
1083 /// The `/` operator (division)
1085 /// The `%` operator (modulus)
1087 /// The `^` operator (bitwise xor)
1089 /// The `&` operator (bitwise and)
1091 /// The `|` operator (bitwise or)
1093 /// The `<<` operator (shift left)
1095 /// The `>>` operator (shift right)
1097 /// The `==` operator (equality)
1099 /// The `<` operator (less than)
1101 /// The `<=` operator (less than or equal to)
1103 /// The `!=` operator (not equal to)
1105 /// The `>=` operator (greater than or equal to)
1107 /// The `>` operator (greater than)
1112 pub fn is_checkable(self) -> bool {
1115 Add | Sub | Mul | Shl | Shr => true,
1121 #[derive(Copy, Clone, Debug, PartialEq, Eq, RustcEncodable, RustcDecodable)]
1123 /// The `!` operator for logical inversion
1125 /// The `-` operator for negation
1129 impl<'tcx> Debug for Rvalue<'tcx> {
1130 fn fmt(&self, fmt: &mut Formatter) -> fmt::Result {
1131 use self::Rvalue::*;
1134 Use(ref lvalue) => write!(fmt, "{:?}", lvalue),
1135 Repeat(ref a, ref b) => write!(fmt, "[{:?}; {:?}]", a, b),
1136 Len(ref a) => write!(fmt, "Len({:?})", a),
1137 Cast(ref kind, ref lv, ref ty) => write!(fmt, "{:?} as {:?} ({:?})", lv, ty, kind),
1138 BinaryOp(ref op, ref a, ref b) => write!(fmt, "{:?}({:?}, {:?})", op, a, b),
1139 CheckedBinaryOp(ref op, ref a, ref b) => {
1140 write!(fmt, "Checked{:?}({:?}, {:?})", op, a, b)
1142 UnaryOp(ref op, ref a) => write!(fmt, "{:?}({:?})", op, a),
1143 Discriminant(ref lval) => write!(fmt, "discriminant({:?})", lval),
1144 Box(ref t) => write!(fmt, "Box({:?})", t),
1145 Ref(_, borrow_kind, ref lv) => {
1146 let kind_str = match borrow_kind {
1147 BorrowKind::Shared => "",
1148 BorrowKind::Mut | BorrowKind::Unique => "mut ",
1150 write!(fmt, "&{}{:?}", kind_str, lv)
1153 Aggregate(ref kind, ref lvs) => {
1154 fn fmt_tuple(fmt: &mut Formatter, lvs: &[Operand]) -> fmt::Result {
1155 let mut tuple_fmt = fmt.debug_tuple("");
1157 tuple_fmt.field(lv);
1163 AggregateKind::Array(_) => write!(fmt, "{:?}", lvs),
1165 AggregateKind::Tuple => {
1167 0 => write!(fmt, "()"),
1168 1 => write!(fmt, "({:?},)", lvs[0]),
1169 _ => fmt_tuple(fmt, lvs),
1173 AggregateKind::Adt(adt_def, variant, substs, _) => {
1174 let variant_def = &adt_def.variants[variant];
1176 ppaux::parameterized(fmt, substs, variant_def.did, &[])?;
1178 match variant_def.ctor_kind {
1179 CtorKind::Const => Ok(()),
1180 CtorKind::Fn => fmt_tuple(fmt, lvs),
1181 CtorKind::Fictive => {
1182 let mut struct_fmt = fmt.debug_struct("");
1183 for (field, lv) in variant_def.fields.iter().zip(lvs) {
1184 struct_fmt.field(&field.name.as_str(), lv);
1191 AggregateKind::Closure(def_id, _) => ty::tls::with(|tcx| {
1192 if let Some(node_id) = tcx.hir.as_local_node_id(def_id) {
1193 let name = format!("[closure@{:?}]", tcx.hir.span(node_id));
1194 let mut struct_fmt = fmt.debug_struct(&name);
1196 tcx.with_freevars(node_id, |freevars| {
1197 for (freevar, lv) in freevars.iter().zip(lvs) {
1198 let def_id = freevar.def.def_id();
1199 let var_id = tcx.hir.as_local_node_id(def_id).unwrap();
1200 let var_name = tcx.local_var_name_str(var_id);
1201 struct_fmt.field(&var_name, lv);
1207 write!(fmt, "[closure]")
1216 ///////////////////////////////////////////////////////////////////////////
1219 /// Two constants are equal if they are the same constant. Note that
1220 /// this does not necessarily mean that they are "==" in Rust -- in
1221 /// particular one must be wary of `NaN`!
1223 #[derive(Clone, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
1224 pub struct Constant<'tcx> {
1227 pub literal: Literal<'tcx>,
1230 newtype_index!(Promoted, "promoted");
1232 #[derive(Clone, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
1233 pub enum Literal<'tcx> {
1236 substs: &'tcx Substs<'tcx>,
1239 value: ConstVal<'tcx>,
1242 // Index into the `promoted` vector of `Mir`.
1247 impl<'tcx> Debug for Constant<'tcx> {
1248 fn fmt(&self, fmt: &mut Formatter) -> fmt::Result {
1249 write!(fmt, "{:?}", self.literal)
1253 impl<'tcx> Debug for Literal<'tcx> {
1254 fn fmt(&self, fmt: &mut Formatter) -> fmt::Result {
1255 use self::Literal::*;
1257 Item { def_id, substs } => {
1258 ppaux::parameterized(fmt, substs, def_id, &[])
1260 Value { ref value } => {
1261 write!(fmt, "const ")?;
1262 fmt_const_val(fmt, value)
1264 Promoted { index } => {
1265 write!(fmt, "{:?}", index)
1271 /// Write a `ConstVal` in a way closer to the original source code than the `Debug` output.
1272 fn fmt_const_val<W: Write>(fmt: &mut W, const_val: &ConstVal) -> fmt::Result {
1273 use middle::const_val::ConstVal::*;
1275 Float(f) => write!(fmt, "{:?}", f),
1276 Integral(n) => write!(fmt, "{}", n),
1277 Str(ref s) => write!(fmt, "{:?}", s),
1278 ByteStr(ref bytes) => {
1279 let escaped: String = bytes
1281 .flat_map(|&ch| ascii::escape_default(ch).map(|c| c as char))
1283 write!(fmt, "b\"{}\"", escaped)
1285 Bool(b) => write!(fmt, "{:?}", b),
1286 Function(def_id, _) => write!(fmt, "{}", item_path_str(def_id)),
1287 Struct(_) | Tuple(_) | Array(_) | Repeat(..) =>
1288 bug!("ConstVal `{:?}` should not be in MIR", const_val),
1289 Char(c) => write!(fmt, "{:?}", c),
1293 fn item_path_str(def_id: DefId) -> String {
1294 ty::tls::with(|tcx| tcx.item_path_str(def_id))
1297 impl<'tcx> ControlFlowGraph for Mir<'tcx> {
1299 type Node = BasicBlock;
1301 fn num_nodes(&self) -> usize { self.basic_blocks.len() }
1303 fn start_node(&self) -> Self::Node { START_BLOCK }
1305 fn predecessors<'graph>(&'graph self, node: Self::Node)
1306 -> <Self as GraphPredecessors<'graph>>::Iter
1308 self.predecessors_for(node).clone().into_iter()
1310 fn successors<'graph>(&'graph self, node: Self::Node)
1311 -> <Self as GraphSuccessors<'graph>>::Iter
1313 self.basic_blocks[node].terminator().successors().into_owned().into_iter()
1317 impl<'a, 'b> GraphPredecessors<'b> for Mir<'a> {
1318 type Item = BasicBlock;
1319 type Iter = IntoIter<BasicBlock>;
1322 impl<'a, 'b> GraphSuccessors<'b> for Mir<'a> {
1323 type Item = BasicBlock;
1324 type Iter = IntoIter<BasicBlock>;
1327 #[derive(Copy, Clone, PartialEq, Eq, Hash, Ord, PartialOrd)]
1328 pub struct Location {
1329 /// the location is within this block
1330 pub block: BasicBlock,
1332 /// the location is the start of the this statement; or, if `statement_index`
1333 /// == num-statements, then the start of the terminator.
1334 pub statement_index: usize,
1337 impl fmt::Debug for Location {
1338 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
1339 write!(fmt, "{:?}[{}]", self.block, self.statement_index)
1344 pub fn dominates(&self, other: &Location, dominators: &Dominators<BasicBlock>) -> bool {
1345 if self.block == other.block {
1346 self.statement_index <= other.statement_index
1348 dominators.is_dominated_by(other.block, self.block)
1355 * TypeFoldable implementations for MIR types
1358 impl<'tcx> TypeFoldable<'tcx> for Mir<'tcx> {
1359 fn super_fold_with<'gcx: 'tcx, F: TypeFolder<'gcx, 'tcx>>(&self, folder: &mut F) -> Self {
1361 basic_blocks: self.basic_blocks.fold_with(folder),
1362 visibility_scopes: self.visibility_scopes.clone(),
1363 promoted: self.promoted.fold_with(folder),
1364 return_ty: self.return_ty.fold_with(folder),
1365 local_decls: self.local_decls.fold_with(folder),
1366 arg_count: self.arg_count,
1367 upvar_decls: self.upvar_decls.clone(),
1368 spread_arg: self.spread_arg,
1370 cache: cache::Cache::new()
1374 fn super_visit_with<V: TypeVisitor<'tcx>>(&self, visitor: &mut V) -> bool {
1375 self.basic_blocks.visit_with(visitor) ||
1376 self.promoted.visit_with(visitor) ||
1377 self.return_ty.visit_with(visitor) ||
1378 self.local_decls.visit_with(visitor)
1382 impl<'tcx> TypeFoldable<'tcx> for LocalDecl<'tcx> {
1383 fn super_fold_with<'gcx: 'tcx, F: TypeFolder<'gcx, 'tcx>>(&self, folder: &mut F) -> Self {
1385 ty: self.ty.fold_with(folder),
1390 fn super_visit_with<V: TypeVisitor<'tcx>>(&self, visitor: &mut V) -> bool {
1391 self.ty.visit_with(visitor)
1395 impl<'tcx> TypeFoldable<'tcx> for BasicBlockData<'tcx> {
1396 fn super_fold_with<'gcx: 'tcx, F: TypeFolder<'gcx, 'tcx>>(&self, folder: &mut F) -> Self {
1398 statements: self.statements.fold_with(folder),
1399 terminator: self.terminator.fold_with(folder),
1400 is_cleanup: self.is_cleanup
1404 fn super_visit_with<V: TypeVisitor<'tcx>>(&self, visitor: &mut V) -> bool {
1405 self.statements.visit_with(visitor) || self.terminator.visit_with(visitor)
1409 impl<'tcx> TypeFoldable<'tcx> for Statement<'tcx> {
1410 fn super_fold_with<'gcx: 'tcx, F: TypeFolder<'gcx, 'tcx>>(&self, folder: &mut F) -> Self {
1411 use mir::StatementKind::*;
1413 let kind = match self.kind {
1414 Assign(ref lval, ref rval) => Assign(lval.fold_with(folder), rval.fold_with(folder)),
1415 SetDiscriminant { ref lvalue, variant_index } => SetDiscriminant {
1416 lvalue: lvalue.fold_with(folder),
1417 variant_index: variant_index
1419 StorageLive(ref lval) => StorageLive(lval.fold_with(folder)),
1420 StorageDead(ref lval) => StorageDead(lval.fold_with(folder)),
1421 InlineAsm { ref asm, ref outputs, ref inputs } => InlineAsm {
1423 outputs: outputs.fold_with(folder),
1424 inputs: inputs.fold_with(folder)
1429 source_info: self.source_info,
1434 fn super_visit_with<V: TypeVisitor<'tcx>>(&self, visitor: &mut V) -> bool {
1435 use mir::StatementKind::*;
1438 Assign(ref lval, ref rval) => { lval.visit_with(visitor) || rval.visit_with(visitor) }
1439 SetDiscriminant { ref lvalue, .. } |
1440 StorageLive(ref lvalue) |
1441 StorageDead(ref lvalue) => lvalue.visit_with(visitor),
1442 InlineAsm { ref outputs, ref inputs, .. } =>
1443 outputs.visit_with(visitor) || inputs.visit_with(visitor),
1449 impl<'tcx> TypeFoldable<'tcx> for Terminator<'tcx> {
1450 fn super_fold_with<'gcx: 'tcx, F: TypeFolder<'gcx, 'tcx>>(&self, folder: &mut F) -> Self {
1451 use mir::TerminatorKind::*;
1453 let kind = match self.kind {
1454 Goto { target } => Goto { target: target },
1455 SwitchInt { ref discr, switch_ty, ref values, ref targets } => SwitchInt {
1456 discr: discr.fold_with(folder),
1457 switch_ty: switch_ty.fold_with(folder),
1458 values: values.clone(),
1459 targets: targets.clone()
1461 Drop { ref location, target, unwind } => Drop {
1462 location: location.fold_with(folder),
1466 DropAndReplace { ref location, ref value, target, unwind } => DropAndReplace {
1467 location: location.fold_with(folder),
1468 value: value.fold_with(folder),
1472 Call { ref func, ref args, ref destination, cleanup } => {
1473 let dest = destination.as_ref().map(|&(ref loc, dest)| {
1474 (loc.fold_with(folder), dest)
1478 func: func.fold_with(folder),
1479 args: args.fold_with(folder),
1484 Assert { ref cond, expected, ref msg, target, cleanup } => {
1485 let msg = if let AssertMessage::BoundsCheck { ref len, ref index } = *msg {
1486 AssertMessage::BoundsCheck {
1487 len: len.fold_with(folder),
1488 index: index.fold_with(folder),
1494 cond: cond.fold_with(folder),
1503 Unreachable => Unreachable,
1506 source_info: self.source_info,
1511 fn super_visit_with<V: TypeVisitor<'tcx>>(&self, visitor: &mut V) -> bool {
1512 use mir::TerminatorKind::*;
1515 SwitchInt { ref discr, switch_ty, .. } =>
1516 discr.visit_with(visitor) || switch_ty.visit_with(visitor),
1517 Drop { ref location, ..} => location.visit_with(visitor),
1518 DropAndReplace { ref location, ref value, ..} =>
1519 location.visit_with(visitor) || value.visit_with(visitor),
1520 Call { ref func, ref args, ref destination, .. } => {
1521 let dest = if let Some((ref loc, _)) = *destination {
1522 loc.visit_with(visitor)
1524 dest || func.visit_with(visitor) || args.visit_with(visitor)
1526 Assert { ref cond, ref msg, .. } => {
1527 if cond.visit_with(visitor) {
1528 if let AssertMessage::BoundsCheck { ref len, ref index } = *msg {
1529 len.visit_with(visitor) || index.visit_with(visitor)
1540 Unreachable => false
1545 impl<'tcx> TypeFoldable<'tcx> for Lvalue<'tcx> {
1546 fn super_fold_with<'gcx: 'tcx, F: TypeFolder<'gcx, 'tcx>>(&self, folder: &mut F) -> Self {
1548 &Lvalue::Projection(ref p) => Lvalue::Projection(p.fold_with(folder)),
1553 fn super_visit_with<V: TypeVisitor<'tcx>>(&self, visitor: &mut V) -> bool {
1554 if let &Lvalue::Projection(ref p) = self {
1555 p.visit_with(visitor)
1562 impl<'tcx> TypeFoldable<'tcx> for Rvalue<'tcx> {
1563 fn super_fold_with<'gcx: 'tcx, F: TypeFolder<'gcx, 'tcx>>(&self, folder: &mut F) -> Self {
1566 Use(ref op) => Use(op.fold_with(folder)),
1567 Repeat(ref op, len) => Repeat(op.fold_with(folder), len),
1568 Ref(region, bk, ref lval) => Ref(region.fold_with(folder), bk, lval.fold_with(folder)),
1569 Len(ref lval) => Len(lval.fold_with(folder)),
1570 Cast(kind, ref op, ty) => Cast(kind, op.fold_with(folder), ty.fold_with(folder)),
1571 BinaryOp(op, ref rhs, ref lhs) =>
1572 BinaryOp(op, rhs.fold_with(folder), lhs.fold_with(folder)),
1573 CheckedBinaryOp(op, ref rhs, ref lhs) =>
1574 CheckedBinaryOp(op, rhs.fold_with(folder), lhs.fold_with(folder)),
1575 UnaryOp(op, ref val) => UnaryOp(op, val.fold_with(folder)),
1576 Discriminant(ref lval) => Discriminant(lval.fold_with(folder)),
1577 Box(ty) => Box(ty.fold_with(folder)),
1578 Aggregate(ref kind, ref fields) => {
1579 let kind = match *kind {
1580 AggregateKind::Array(ty) => AggregateKind::Array(ty.fold_with(folder)),
1581 AggregateKind::Tuple => AggregateKind::Tuple,
1582 AggregateKind::Adt(def, v, substs, n) =>
1583 AggregateKind::Adt(def, v, substs.fold_with(folder), n),
1584 AggregateKind::Closure(id, substs) =>
1585 AggregateKind::Closure(id, substs.fold_with(folder))
1587 Aggregate(kind, fields.fold_with(folder))
1592 fn super_visit_with<V: TypeVisitor<'tcx>>(&self, visitor: &mut V) -> bool {
1595 Use(ref op) => op.visit_with(visitor),
1596 Repeat(ref op, _) => op.visit_with(visitor),
1597 Ref(region, _, ref lval) => region.visit_with(visitor) || lval.visit_with(visitor),
1598 Len(ref lval) => lval.visit_with(visitor),
1599 Cast(_, ref op, ty) => op.visit_with(visitor) || ty.visit_with(visitor),
1600 BinaryOp(_, ref rhs, ref lhs) |
1601 CheckedBinaryOp(_, ref rhs, ref lhs) =>
1602 rhs.visit_with(visitor) || lhs.visit_with(visitor),
1603 UnaryOp(_, ref val) => val.visit_with(visitor),
1604 Discriminant(ref lval) => lval.visit_with(visitor),
1605 Box(ty) => ty.visit_with(visitor),
1606 Aggregate(ref kind, ref fields) => {
1608 AggregateKind::Array(ty) => ty.visit_with(visitor),
1609 AggregateKind::Tuple => false,
1610 AggregateKind::Adt(_, _, substs, _) => substs.visit_with(visitor),
1611 AggregateKind::Closure(_, substs) => substs.visit_with(visitor)
1612 }) || fields.visit_with(visitor)
1618 impl<'tcx> TypeFoldable<'tcx> for Operand<'tcx> {
1619 fn super_fold_with<'gcx: 'tcx, F: TypeFolder<'gcx, 'tcx>>(&self, folder: &mut F) -> Self {
1621 Operand::Consume(ref lval) => Operand::Consume(lval.fold_with(folder)),
1622 Operand::Constant(ref c) => Operand::Constant(c.fold_with(folder)),
1626 fn super_visit_with<V: TypeVisitor<'tcx>>(&self, visitor: &mut V) -> bool {
1628 Operand::Consume(ref lval) => lval.visit_with(visitor),
1629 Operand::Constant(ref c) => c.visit_with(visitor)
1634 impl<'tcx, B, V> TypeFoldable<'tcx> for Projection<'tcx, B, V>
1635 where B: TypeFoldable<'tcx>, V: TypeFoldable<'tcx>
1637 fn super_fold_with<'gcx: 'tcx, F: TypeFolder<'gcx, 'tcx>>(&self, folder: &mut F) -> Self {
1638 use mir::ProjectionElem::*;
1640 let base = self.base.fold_with(folder);
1641 let elem = match self.elem {
1643 Field(f, ty) => Field(f, ty.fold_with(folder)),
1644 Index(ref v) => Index(v.fold_with(folder)),
1645 ref elem => elem.clone()
1654 fn super_visit_with<Vs: TypeVisitor<'tcx>>(&self, visitor: &mut Vs) -> bool {
1655 use mir::ProjectionElem::*;
1657 self.base.visit_with(visitor) ||
1659 Field(_, ty) => ty.visit_with(visitor),
1660 Index(ref v) => v.visit_with(visitor),
1666 impl<'tcx> TypeFoldable<'tcx> for Constant<'tcx> {
1667 fn super_fold_with<'gcx: 'tcx, F: TypeFolder<'gcx, 'tcx>>(&self, folder: &mut F) -> Self {
1669 span: self.span.clone(),
1670 ty: self.ty.fold_with(folder),
1671 literal: self.literal.fold_with(folder)
1674 fn super_visit_with<V: TypeVisitor<'tcx>>(&self, visitor: &mut V) -> bool {
1675 self.ty.visit_with(visitor) || self.literal.visit_with(visitor)
1679 impl<'tcx> TypeFoldable<'tcx> for Literal<'tcx> {
1680 fn super_fold_with<'gcx: 'tcx, F: TypeFolder<'gcx, 'tcx>>(&self, folder: &mut F) -> Self {
1682 Literal::Item { def_id, substs } => Literal::Item {
1684 substs: substs.fold_with(folder)
1689 fn super_visit_with<V: TypeVisitor<'tcx>>(&self, visitor: &mut V) -> bool {
1691 Literal::Item { substs, .. } => substs.visit_with(visitor),