Struct rustc_middle::mir::Body
source · pub struct Body<'tcx> {Show 16 fields
pub basic_blocks: BasicBlocks<'tcx>,
pub phase: MirPhase,
pub pass_count: usize,
pub source: MirSource<'tcx>,
pub source_scopes: IndexVec<SourceScope, SourceScopeData<'tcx>>,
pub generator: Option<Box<GeneratorInfo<'tcx>>>,
pub local_decls: IndexVec<Local, LocalDecl<'tcx>>,
pub user_type_annotations: CanonicalUserTypeAnnotations<'tcx>,
pub arg_count: usize,
pub spread_arg: Option<Local>,
pub var_debug_info: Vec<VarDebugInfo<'tcx>>,
pub span: Span,
pub required_consts: Vec<ConstOperand<'tcx>>,
pub is_polymorphic: bool,
pub injection_phase: Option<MirPhase>,
pub tainted_by_errors: Option<ErrorGuaranteed>,
}
Expand description
The lowered representation of a single function.
Fields§
§basic_blocks: BasicBlocks<'tcx>
A list of basic blocks. References to basic block use a newtyped index type BasicBlock
that indexes into this vector.
phase: MirPhase
Records how far through the “desugaring and optimization” process this particular MIR has traversed. This is particularly useful when inlining, since in that context we instantiate the promoted constants and add them to our promoted vector – but those promoted items have already been optimized, whereas ours have not. This field allows us to see the difference and forego optimization on the inlined promoted items.
pass_count: usize
How many passses we have executed since starting the current phase. Used for debug output.
source: MirSource<'tcx>
§source_scopes: IndexVec<SourceScope, SourceScopeData<'tcx>>
A list of source scopes; these are referenced by statements
and used for debuginfo. Indexed by a SourceScope
.
generator: Option<Box<GeneratorInfo<'tcx>>>
§local_decls: IndexVec<Local, LocalDecl<'tcx>>
Declarations of locals.
The first local is the return value pointer, followed by arg_count
locals for the function arguments, followed by any user-declared
variables and temporaries.
user_type_annotations: CanonicalUserTypeAnnotations<'tcx>
User type annotations.
arg_count: usize
The number of arguments this function takes.
Starting at local 1, arg_count
locals will be provided by the caller
and can be assumed to be initialized.
If this MIR was built for a constant, this will be 0.
spread_arg: Option<Local>
Mark an argument local (which must be a tuple) as getting passed as its individual components at the LLVM level.
This is used for the “rust-call” ABI.
var_debug_info: Vec<VarDebugInfo<'tcx>>
Debug information pertaining to user variables, including captures.
span: Span
A span representing this MIR, for error reporting.
required_consts: Vec<ConstOperand<'tcx>>
Constants that are required to evaluate successfully for this MIR to be well-formed. We hold in this field all the constants we are not able to evaluate yet.
is_polymorphic: bool
Does this body use generic parameters. This is used for the ConstEvaluatable
check.
Note that this does not actually mean that this body is not computable right now.
The repeat count in the following example is polymorphic, but can still be evaluated
without knowing anything about the type parameter T
.
fn test<T>() {
let _ = [0; std::mem::size_of::<*mut T>()];
}
WARNING: Do not change this flags after the MIR was originally created, even if an optimization
removed the last mention of all generic params. We do not want to rely on optimizations and
potentially allow things like [u8; std::mem::size_of::<T>() * 0]
due to this.
injection_phase: Option<MirPhase>
The phase at which this MIR should be “injected” into the compilation process.
Everything that comes before this MirPhase
should be skipped.
This is only Some
if the function that this body comes from was annotated with rustc_custom_mir
.
tainted_by_errors: Option<ErrorGuaranteed>
Implementations§
source§impl<'tcx> Body<'tcx>
impl<'tcx> Body<'tcx>
pub fn new( source: MirSource<'tcx>, basic_blocks: IndexVec<BasicBlock, BasicBlockData<'tcx>>, source_scopes: IndexVec<SourceScope, SourceScopeData<'tcx>>, local_decls: IndexVec<Local, LocalDecl<'tcx>>, user_type_annotations: CanonicalUserTypeAnnotations<'tcx>, arg_count: usize, var_debug_info: Vec<VarDebugInfo<'tcx>>, span: Span, generator_kind: Option<GeneratorKind>, tainted_by_errors: Option<ErrorGuaranteed> ) -> Self
sourcepub fn new_cfg_only(
basic_blocks: IndexVec<BasicBlock, BasicBlockData<'tcx>>
) -> Self
pub fn new_cfg_only( basic_blocks: IndexVec<BasicBlock, BasicBlockData<'tcx>> ) -> Self
Returns a partially initialized MIR body containing only a list of basic blocks.
The returned MIR contains no LocalDecl
s (even for the return place) or source scopes. It
is only useful for testing but cannot be #[cfg(test)]
because it is used in a different
crate.
pub fn basic_blocks_mut( &mut self ) -> &mut IndexVec<BasicBlock, BasicBlockData<'tcx>>
pub fn local_kind(&self, local: Local) -> LocalKind
sourcepub fn mut_vars_iter<'a>(
&'a self
) -> impl Iterator<Item = Local> + Captures<'tcx> + 'a
pub fn mut_vars_iter<'a>( &'a self ) -> impl Iterator<Item = Local> + Captures<'tcx> + 'a
Returns an iterator over all user-declared mutable locals.
sourcepub fn mut_vars_and_args_iter<'a>(
&'a self
) -> impl Iterator<Item = Local> + Captures<'tcx> + 'a
pub fn mut_vars_and_args_iter<'a>( &'a self ) -> impl Iterator<Item = Local> + Captures<'tcx> + 'a
Returns an iterator over all user-declared mutable arguments and locals.
sourcepub fn args_iter(&self) -> impl Iterator<Item = Local> + ExactSizeIterator
pub fn args_iter(&self) -> impl Iterator<Item = Local> + ExactSizeIterator
Returns an iterator over all function arguments.
sourcepub fn vars_and_temps_iter(
&self
) -> impl DoubleEndedIterator<Item = Local> + ExactSizeIterator
pub fn vars_and_temps_iter( &self ) -> impl DoubleEndedIterator<Item = Local> + ExactSizeIterator
Returns an iterator over all user-defined variables and compiler-generated temporaries (all locals that are neither arguments nor the return place).
pub fn drain_vars_and_temps<'a>( &'a mut self ) -> impl Iterator<Item = LocalDecl<'tcx>> + 'a
sourcepub fn source_info(&self, location: Location) -> &SourceInfo
pub fn source_info(&self, location: Location) -> &SourceInfo
Returns the source info associated with location
.
sourcepub fn return_ty(&self) -> Ty<'tcx>
pub fn return_ty(&self) -> Ty<'tcx>
Returns the return type; it always return first element from local_decls
array.
sourcepub fn bound_return_ty(&self) -> EarlyBinder<Ty<'tcx>>
pub fn bound_return_ty(&self) -> EarlyBinder<Ty<'tcx>>
Returns the return type; it always return first element from local_decls
array.
sourcepub fn terminator_loc(&self, bb: BasicBlock) -> Location
pub fn terminator_loc(&self, bb: BasicBlock) -> Location
Gets the location of the terminator for the given block.
pub fn stmt_at( &self, location: Location ) -> Either<&Statement<'tcx>, &Terminator<'tcx>>
pub fn yield_ty(&self) -> Option<Ty<'tcx>>
pub fn generator_layout(&self) -> Option<&GeneratorLayout<'tcx>>
pub fn generator_drop(&self) -> Option<&Body<'tcx>>
pub fn generator_kind(&self) -> Option<GeneratorKind>
pub fn should_skip(&self) -> bool
pub fn is_custom_mir(&self) -> bool
Trait Implementations§
source§impl<'tcx> ArenaAllocatable<'tcx, IsNotCopy> for Body<'tcx>
impl<'tcx> ArenaAllocatable<'tcx, IsNotCopy> for Body<'tcx>
fn allocate_on<'a>(self, arena: &'a Arena<'tcx>) -> &'a mut Self
fn allocate_from_iter<'a>( arena: &'a Arena<'tcx>, iter: impl IntoIterator<Item = Self> ) -> &'a mut [Self]
source§impl<'tcx> HasLocalDecls<'tcx> for Body<'tcx>
impl<'tcx> HasLocalDecls<'tcx> for Body<'tcx>
fn local_decls(&self) -> &LocalDecls<'tcx>
source§impl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for Body<'tcx>
impl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for Body<'tcx>
fn hash_stable( &self, __hcx: &mut StableHashingContext<'__ctx>, __hasher: &mut StableHasher )
source§impl<'tcx> Index<BasicBlock> for Body<'tcx>
impl<'tcx> Index<BasicBlock> for Body<'tcx>
§type Output = BasicBlockData<'tcx>
type Output = BasicBlockData<'tcx>
source§fn index(&self, index: BasicBlock) -> &BasicBlockData<'tcx>
fn index(&self, index: BasicBlock) -> &BasicBlockData<'tcx>
container[index]
) operation. Read moresource§impl<'tcx> IndexMut<BasicBlock> for Body<'tcx>
impl<'tcx> IndexMut<BasicBlock> for Body<'tcx>
source§fn index_mut(&mut self, index: BasicBlock) -> &mut BasicBlockData<'tcx>
fn index_mut(&mut self, index: BasicBlock) -> &mut BasicBlockData<'tcx>
container[index]
) operation. Read moresource§impl<'tcx, D: TyDecoder<I = TyCtxt<'tcx>>> RefDecodable<'tcx, D> for Body<'tcx>
impl<'tcx, D: TyDecoder<I = TyCtxt<'tcx>>> RefDecodable<'tcx, D> for Body<'tcx>
fn decode(decoder: &mut D) -> &'tcx Self
source§impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for Body<'tcx>
impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for Body<'tcx>
source§fn try_fold_with<__F: FallibleTypeFolder<TyCtxt<'tcx>>>(
self,
__folder: &mut __F
) -> Result<Self, __F::Error>
fn try_fold_with<__F: FallibleTypeFolder<TyCtxt<'tcx>>>( self, __folder: &mut __F ) -> Result<Self, __F::Error>
source§fn fold_with<F>(self, folder: &mut F) -> Selfwhere
F: TypeFolder<I>,
fn fold_with<F>(self, folder: &mut F) -> Selfwhere F: TypeFolder<I>,
try_fold_with
for use with infallible
folders. Do not override this method, to ensure coherence with
try_fold_with
.source§impl<'tcx> TypeVisitable<TyCtxt<'tcx>> for Body<'tcx>
impl<'tcx> TypeVisitable<TyCtxt<'tcx>> for Body<'tcx>
source§fn visit_with<__V: TypeVisitor<TyCtxt<'tcx>>>(
&self,
__visitor: &mut __V
) -> ControlFlow<__V::BreakTy>
fn visit_with<__V: TypeVisitor<TyCtxt<'tcx>>>( &self, __visitor: &mut __V ) -> ControlFlow<__V::BreakTy>
Auto Trait Implementations§
impl<'tcx> !RefUnwindSafe for Body<'tcx>
impl<'tcx> !Send for Body<'tcx>
impl<'tcx> !Sync for Body<'tcx>
impl<'tcx> Unpin for Body<'tcx>
impl<'tcx> !UnwindSafe for Body<'tcx>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
source§impl<Tcx, T> DepNodeParams<Tcx> for Twhere
Tcx: DepContext,
T: for<'a> HashStable<StableHashingContext<'a>> + Debug,
impl<Tcx, T> DepNodeParams<Tcx> for Twhere Tcx: DepContext, T: for<'a> HashStable<StableHashingContext<'a>> + Debug,
default fn fingerprint_style() -> FingerprintStyle
source§default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint
default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint
default fn to_debug_str(&self, _: Tcx) -> String
source§default fn recover(_: Tcx, _: &DepNode) -> Option<T>
default fn recover(_: Tcx, _: &DepNode) -> Option<T>
DepNode
,
something which is needed when forcing DepNode
s during red-green
evaluation. The query system will only call this method if
fingerprint_style()
is not FingerprintStyle::Opaque
.
It is always valid to return None
here, in which case incremental
compilation will treat the query as having changed instead of forcing it.source§impl<P> IntoQueryParam<P> for P
impl<P> IntoQueryParam<P> for P
fn into_query_param(self) -> P
source§impl<'tcx, T> IsSuggestable<'tcx> for Twhere
T: TypeVisitable<TyCtxt<'tcx>> + TypeFoldable<TyCtxt<'tcx>>,
impl<'tcx, T> IsSuggestable<'tcx> for Twhere T: TypeVisitable<TyCtxt<'tcx>> + TypeFoldable<TyCtxt<'tcx>>,
source§impl<T> MaybeResult<T> for T
impl<T> MaybeResult<T> for T
source§impl<'tcx, T> ToPredicate<'tcx, T> for T
impl<'tcx, T> ToPredicate<'tcx, T> for T
fn to_predicate(self, _tcx: TyCtxt<'tcx>) -> T
source§impl<'tcx, T> TypeVisitableExt<'tcx> for Twhere
T: TypeVisitable<TyCtxt<'tcx>>,
impl<'tcx, T> TypeVisitableExt<'tcx> for Twhere T: TypeVisitable<TyCtxt<'tcx>>,
source§fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool
fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool
true
if self
has any late-bound regions that are either
bound by binder
or bound by some binder outside of binder
.
If binder
is ty::INNERMOST
, this indicates whether
there are any late-bound regions that appear free.source§fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
true
if this type has any regions that escape binder
(and
hence are not bound by it).source§fn has_escaping_bound_vars(&self) -> bool
fn has_escaping_bound_vars(&self) -> bool
true
if this type has regions that are not a part of the type.
For example, for<'a> fn(&'a i32)
return false
, while fn(&'a i32)
would return true
. The latter can occur when traversing through the
former. Read morefn has_type_flags(&self, flags: TypeFlags) -> bool
fn has_projections(&self) -> bool
fn has_inherent_projections(&self) -> bool
fn has_opaque_types(&self) -> bool
fn has_generators(&self) -> bool
fn references_error(&self) -> bool
fn error_reported(&self) -> Result<(), ErrorGuaranteed>
fn has_non_region_param(&self) -> bool
fn has_infer_regions(&self) -> bool
fn has_infer_types(&self) -> bool
fn has_non_region_infer(&self) -> bool
fn has_infer(&self) -> bool
fn has_placeholders(&self) -> bool
fn has_non_region_placeholders(&self) -> bool
fn has_param(&self) -> bool
source§fn has_free_regions(&self) -> bool
fn has_free_regions(&self) -> bool
fn has_erased_regions(&self) -> bool
source§fn has_erasable_regions(&self) -> bool
fn has_erasable_regions(&self) -> bool
source§fn is_global(&self) -> bool
fn is_global(&self) -> bool
source§fn has_late_bound_regions(&self) -> bool
fn has_late_bound_regions(&self) -> bool
source§fn has_non_region_late_bound(&self) -> bool
fn has_non_region_late_bound(&self) -> bool
source§fn has_late_bound_vars(&self) -> bool
fn has_late_bound_vars(&self) -> bool
source§fn still_further_specializable(&self) -> bool
fn still_further_specializable(&self) -> bool
impl
specialization.source§impl<Tcx, T> Value<Tcx> for Twhere
Tcx: DepContext,
impl<Tcx, T> Value<Tcx> for Twhere Tcx: DepContext,
default fn from_cycle_error( tcx: Tcx, cycle: &[QueryInfo], _guar: ErrorGuaranteed ) -> T
Layout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...)
attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.
Size: 392 bytes