VnState in rustc_mir_transform::gvn - Rust
Description: API documentation for the Rust `VnState` struct in crate `rustc_mir_transform`.

Skip to main content

## VnState

# Struct VnState

Source

    struct VnState<'body, 'a, 'tcx> {
        tcx: TyCtxt<'tcx>,
        ecx: InterpCx<'tcx, DummyMachine>,
        local_decls: &'body LocalDecls<'tcx>,
        is_coroutine: bool,
        locals: IndexVec<Local, Option<VnIndex>>,
        rev_locals: IndexVec<VnIndex, SmallVec<[Local; 1]>>,
        values: ValueSet<'a, 'tcx>,
        evaluated: IndexVec<VnIndex, Option<Option<&'a OpTy<'tcx>>>>,
        ssa: &'body SsaLocals,
        dominators: Dominators<BasicBlock>,
        reused_locals: DenseBitSet<Local>,
        arena: &'a DroplessArena,
    }

## Fields§

§`tcx: TyCtxt<'tcx>`§`ecx: InterpCx<'tcx, DummyMachine>`§`local_decls: &'body LocalDecls<'tcx>`§`is_coroutine: bool`§`locals: IndexVec<Local, Option<VnIndex>>`

Value stored in each local.

§`rev_locals: IndexVec<VnIndex, SmallVec<[Local; 1]>>`

Locals that are assigned that value.

§`values: ValueSet<'a, 'tcx>`§`evaluated: IndexVec<VnIndex, Option<Option<&'a OpTy<'tcx>>>>`

Values evaluated as constants if possible.

- `None` are values not computed yet;
- `Some(None)` are values for which computation has failed;
- `Some(Some(op))` are successful computations.

§`ssa: &'body SsaLocals`§`dominators: Dominators<BasicBlock>`§`reused_locals: DenseBitSet<Local>`§`arena: &'a DroplessArena`

## Implementations§

Source§

### impl<'body, 'a, 'tcx> VnState<'body, 'a, 'tcx>

Source

#### fn new( tcx: TyCtxt<'tcx>, body: &Body<'tcx>, typing_env: TypingEnv<'tcx>, ssa: &'body SsaLocals, dominators: Dominators<BasicBlock>, local_decls: &'body LocalDecls<'tcx>, arena: &'a DroplessArena, ) -> Self

Source

#### fn typing_env(&self) -> TypingEnv<'tcx>

Source

#### fn insert_unique( &mut self, ty: Ty<'tcx>, value: impl FnOnce(VnOpaque) -> Value<'a, 'tcx>, ) -> VnIndex

Source

#### fn insert(&mut self, ty: Ty<'tcx>, value: Value<'a, 'tcx>) -> VnIndex

Source

#### fn new_opaque(&mut self, ty: Ty<'tcx>) -> VnIndex

Create a new `Value` for which we have no information at all, except that it is distinct from all the others.

Source

#### fn new_argument(&mut self, ty: Ty<'tcx>) -> VnIndex

Source

#### fn new_pointer( &mut self, place: Place<'tcx>, kind: AddressKind, ) -> Option<VnIndex>

Create a new `Value::Address` distinct from all the others.

Source

#### fn insert_constant(&mut self, value: Const<'tcx>) -> VnIndex

Source

#### fn get(&self, index: VnIndex) -> Value<'a, 'tcx>

Source

#### fn ty(&self, index: VnIndex) -> Ty<'tcx>

Source

#### fn assign(&mut self, local: Local, value: VnIndex)

Record that `local` is assigned `value`. `local` must be SSA.

Source

#### fn insert_bool(&mut self, flag: bool) -> VnIndex

Source

#### fn insert_scalar(&mut self, ty: Ty<'tcx>, scalar: Scalar) -> VnIndex

Source

#### fn insert_tuple(&mut self, ty: Ty<'tcx>, values: &[VnIndex]) -> VnIndex

Source

#### fn eval_to_const_inner(&mut self, value: VnIndex) -> Option<OpTy<'tcx>>

Source

#### fn eval_to_const(&mut self, index: VnIndex) -> Option<&'a OpTy<'tcx>>

Source

#### fn dereference_address( &mut self, base: AddressBase, projection: &[ProjectionElem<VnIndex, Ty<'tcx>>], ) -> Option<VnIndex>

Represent the value we obtain by dereferencing an `Address` value.

Source

#### fn project( &mut self, place_ty: PlaceTy<'tcx>, value: VnIndex, proj: ProjectionElem<VnIndex, Ty<'tcx>>, ) -> Option<(PlaceTy<'tcx>, VnIndex)>

Source

#### fn simplify_place_projection( &mut self, place: &mut Place<'tcx>, location: Location, )

Simplify the projection chain if we know better.

Source

#### fn compute_place_value( &mut self, place: Place<'tcx>, location: Location, ) -> Result<VnIndex, PlaceRef<'tcx>>

Represent the value which would be read from `place`. If we succeed, return it. If we fail, return a `PlaceRef` that contains the same value.

Source

#### fn simplify_place_value( &mut self, place: &mut Place<'tcx>, location: Location, ) -> Option<VnIndex>

Represent the value which would be read from `place`, and point `place` to a preexisting place with the same value (if that already exists).

Source

#### fn simplify_operand( &mut self, operand: &mut Operand<'tcx>, location: Location, ) -> Option<VnIndex>

Source

#### fn simplify_rvalue( &mut self, lhs: &Place<'tcx>, rvalue: &mut Rvalue<'tcx>, location: Location, ) -> Option<VnIndex>

Source

#### fn simplify_discriminant(&mut self, place: VnIndex) -> Option<VnIndex>

Source

#### fn try_as_place_elem( &mut self, ty: Ty<'tcx>, proj: ProjectionElem<VnIndex, ()>, loc: Location, ) -> Option<PlaceElem<'tcx>>

Source

#### fn simplify_aggregate_to_copy( &mut self, ty: Ty<'tcx>, variant_index: VariantIdx, fields: &[VnIndex], ) -> Option<VnIndex>

Source

#### fn simplify_aggregate( &mut self, rvalue: &mut Rvalue<'tcx>, location: Location, ) -> Option<VnIndex>

Source

#### fn simplify_unary( &mut self, op: UnOp, arg_op: &mut Operand<'tcx>, location: Location, ) -> Option<VnIndex>

Source

#### fn simplify_binary( &mut self, op: BinOp, lhs_operand: &mut Operand<'tcx>, rhs_operand: &mut Operand<'tcx>, location: Location, ) -> Option<VnIndex>

Source

#### fn simplify_binary_inner( &mut self, op: BinOp, lhs_ty: Ty<'tcx>, lhs: VnIndex, rhs: VnIndex, ) -> Option<VnIndex>

Source

#### fn simplify_cast( &mut self, initial_kind: &mut CastKind, initial_operand: &mut Operand<'tcx>, to: Ty<'tcx>, location: Location, ) -> Option<VnIndex>

Source

#### fn pointers_have_same_metadata( &self, left_ptr_ty: Ty<'tcx>, right_ptr_ty: Ty<'tcx>, ) -> bool

Source

#### fn transmute_may_have_niche_of_interest_to_backend( &self, from_ty: Ty<'tcx>, middle_ty: Ty<'tcx>, to_ty: Ty<'tcx>, ) -> bool

Returns `false` if we’re confident that the middle type doesn’t have an interesting niche so we can skip that step when transmuting.

The backend will emit `assume`s when transmuting between types with niches, so we want to preserve `i32 -> char -> u32` so that that data is around, but it’s fine to skip whole-range-is-value steps like `A -> u32 -> B`.

Source

#### fn value_is_all_in_one_field( &self, ty: Ty<'tcx>, variant: VariantIdx, ) -> Option<(FieldIdx, Ty<'tcx>)>

Source§

### impl<'tcx> VnState<'_, '_, 'tcx>

Source

#### fn try_as_operand( &mut self, index: VnIndex, location: Location, ) -> Option<Operand<'tcx>>

If either `Self::try_as_constant` as `Self::try_as_place` succeeds, returns that result as an `Operand`.

Source

#### fn try_as_constant(&mut self, index: VnIndex) -> Option<ConstOperand<'tcx>>

If `index` is a `Value::Constant`, return the `Constant` to be put in the MIR.

Source

#### fn try_as_evaluated_constant(&mut self, index: VnIndex) -> Option<Const<'tcx>>

Source

#### fn try_as_place( &mut self, index: VnIndex, loc: Location, allow_complex_projection: bool, ) -> Option<Place<'tcx>>

Construct a place which holds the same value as `index` and for which all locals strictly dominate `loc`. If you used this place, add its base local to `reused_locals` to remove storage statements.

Source

#### fn try_as_local(&mut self, index: VnIndex, loc: Location) -> Option<Local>

If there is a local which is assigned `index`, and its assignment strictly dominates `loc`, return it. If you used this local, add it to `reused_locals` to remove storage statements.

## Trait Implementations§

Source§

### impl<'tcx> MutVisitor<'tcx> for VnState<'_, '_, 'tcx>

Source§

#### fn tcx(&self) -> TyCtxt<'tcx>

Source§

#### fn visit_place( &mut self, place: &mut Place<'tcx>, context: PlaceContext, location: Location, )

Source§

#### fn visit_operand(&mut self, operand: &mut Operand<'tcx>, location: Location)

Source§

#### fn visit_assign( &mut self, lhs: &mut Place<'tcx>, rvalue: &mut Rvalue<'tcx>, location: Location, )

Source§

#### fn visit_terminator( &mut self, terminator: &mut Terminator<'tcx>, location: Location, )

Source§

#### fn visit_body(&mut self, body: &mut Body<'tcx>)

Source§

#### fn visit_body_preserves_cfg(&mut self, body: &mut Body<'tcx>)

Source§

#### fn super_body_preserves_cfg(&mut self, body: &mut Body<'tcx>)

Source§

#### fn visit_basic_block_data( &mut self, block: BasicBlock, data: &mut BasicBlockData<'tcx>, )

Source§

#### fn visit_source_scope_data(&mut self, scope_data: &mut SourceScopeData<'tcx>)

Source§

#### fn visit_statement_debuginfo( &mut self, stmt_debuginfo: &mut StmtDebugInfo<'tcx>, location: Location, )

Source§

#### fn visit_statement( &mut self, statement: &mut Statement<'tcx>, location: Location, )

Source§

#### fn visit_assert_message( &mut self, msg: &mut AssertKind<Operand<'tcx>>, location: Location, )

Source§

#### fn visit_rvalue(&mut self, rvalue: &mut Rvalue<'tcx>, location: Location)

Source§

#### fn visit_ascribe_user_ty( &mut self, place: &mut Place<'tcx>, variance: &mut Variance, user_ty: &mut UserTypeProjection, location: Location, )

Source§

#### fn visit_coverage(&mut self, kind: &mut CoverageKind, location: Location)

Source§

#### fn visit_retag( &mut self, kind: &mut RetagKind, place: &mut Place<'tcx>, location: Location, )

Source§

#### fn super_place( &mut self, place: &mut Place<'tcx>, context: PlaceContext, location: Location, )

Source§

#### fn process_projection<'a>( &mut self, projection: &'a [ProjectionElem<Local, Ty<'tcx>>], location: Location, ) -> Option<Vec<ProjectionElem<Local, Ty<'tcx>>>>

Source§

#### fn process_projection_elem( &mut self, elem: ProjectionElem<Local, Ty<'tcx>>, location: Location, ) -> Option<ProjectionElem<Local, Ty<'tcx>>>

Source§

#### fn visit_const_operand( &mut self, constant: &mut ConstOperand<'tcx>, location: Location, )

This is called for every constant in the MIR body and every `required_consts` (i.e., including consts that have been dead-code-eliminated).
Source§

#### fn visit_ty_const(&mut self, ct: &mut Const<'tcx>, location: Location)

Source§

#### fn visit_span(&mut self, span: &mut Span)

Source§

#### fn visit_source_info(&mut self, source_info: &mut SourceInfo)

Source§

#### fn visit_ty(&mut self, ty: &mut Ty<'tcx>, _: TyContext)

Source§

#### fn visit_user_type_projection(&mut self, ty: &mut UserTypeProjection)

Source§

#### fn visit_user_type_annotation( &mut self, index: UserTypeAnnotationIndex, ty: &mut CanonicalUserTypeAnnotation<'tcx>, )

Source§

#### fn visit_region(&mut self, region: &mut Region<'tcx>, _: Location)

Source§

#### fn visit_args( &mut self, args: &mut &'tcx RawList<(), GenericArg<'tcx>>, _: Location, )

Source§

#### fn visit_local_decl(&mut self, local: Local, local_decl: &mut LocalDecl<'tcx>)

Source§

#### fn visit_var_debug_info(&mut self, var_debug_info: &mut VarDebugInfo<'tcx>)

Source§

#### fn visit_local( &mut self, local: &mut Local, context: PlaceContext, location: Location, )

Source§

#### fn visit_source_scope(&mut self, scope: &mut SourceScope)

Source§

#### fn super_body(&mut self, body: &mut Body<'tcx>)

Source§

#### fn super_basic_block_data( &mut self, block: BasicBlock, data: &mut BasicBlockData<'tcx>, )

Source§

#### fn super_source_scope_data(&mut self, scope_data: &mut SourceScopeData<'tcx>)

Source§

#### fn super_statement_debuginfo( &mut self, stmt_debuginfo: &mut StmtDebugInfo<'tcx>, location: Location, )

Source§

#### fn super_statement( &mut self, statement: &mut Statement<'tcx>, location: Location, )

Source§

#### fn super_assign( &mut self, place: &mut Place<'tcx>, rvalue: &mut Rvalue<'tcx>, location: Location, )

Source§

#### fn super_terminator( &mut self, terminator: &mut Terminator<'tcx>, location: Location, )

Source§

#### fn super_assert_message( &mut self, msg: &mut AssertKind<Operand<'tcx>>, location: Location, )

Source§

#### fn super_rvalue(&mut self, rvalue: &mut Rvalue<'tcx>, location: Location)

Source§

#### fn super_operand(&mut self, operand: &mut Operand<'tcx>, location: Location)

Source§

#### fn super_ascribe_user_ty( &mut self, place: &mut Place<'tcx>, variance: &mut Variance, user_ty: &mut UserTypeProjection, location: Location, )

Source§

#### fn super_coverage(&mut self, _kind: &mut CoverageKind, _location: Location)

Source§

#### fn super_retag( &mut self, _kind: &mut RetagKind, place: &mut Place<'tcx>, location: Location, )

Source§

#### fn super_local_decl(&mut self, local: Local, local_decl: &mut LocalDecl<'tcx>)

Source§

#### fn super_local( &mut self, _local: &mut Local, _context: PlaceContext, _location: Location, )

Source§

#### fn super_var_debug_info(&mut self, var_debug_info: &mut VarDebugInfo<'tcx>)

Source§

#### fn super_source_scope(&mut self, _scope: &mut SourceScope)

Source§

#### fn super_const_operand( &mut self, constant: &mut ConstOperand<'tcx>, location: Location, )

Source§

#### fn super_ty_const(&mut self, _ct: &mut Const<'tcx>, _location: Location)

Source§

#### fn super_span(&mut self, _span: &mut Span)

Source§

#### fn super_source_info(&mut self, source_info: &mut SourceInfo)

Source§

#### fn super_user_type_projection(&mut self, _ty: &mut UserTypeProjection)

Source§

#### fn super_user_type_annotation( &mut self, _index: UserTypeAnnotationIndex, ty: &mut CanonicalUserTypeAnnotation<'tcx>, )

Source§

#### fn super_ty(&mut self, _ty: &mut Ty<'tcx>)

Source§

#### fn super_region(&mut self, _region: &mut Region<'tcx>)

Source§

#### fn super_args(&mut self, _args: &mut &'tcx RawList<(), GenericArg<'tcx>>)

Source§

#### fn visit_location(&mut self, body: &mut Body<'tcx>, location: Location)

## Auto Trait Implementations§

§

### impl<'body, 'a, 'tcx> !DynSend for VnState<'body, 'a, 'tcx>

§

### impl<'body, 'a, 'tcx> !DynSync for VnState<'body, 'a, 'tcx>

§

### impl<'body, 'a, 'tcx> !Freeze for VnState<'body, 'a, 'tcx>

§

### impl<'body, 'a, 'tcx> !RefUnwindSafe for VnState<'body, 'a, 'tcx>

§

### impl<'body, 'a, 'tcx> !Send for VnState<'body, 'a, 'tcx>

§

### impl<'body, 'a, 'tcx> !Sync for VnState<'body, 'a, 'tcx>

§

### impl<'body, 'a, 'tcx> Unpin for VnState<'body, 'a, 'tcx>

§

### impl<'body, 'a, 'tcx> UnsafeUnpin for VnState<'body, 'a, 'tcx>

§

### impl<'body, 'a, 'tcx> !UnwindSafe for VnState<'body, 'a, 'tcx>

## Blanket Implementations§

Source§

### impl<T> Aligned for T

Source§

#### const ALIGN: Alignment

Alignment of `Self`.
Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T, R> CollectAndApply<T, R> for T

Source§

#### fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to `f(&iter.collect::<Vec<_>>())`.

Source§

#### type Output = R

Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T> Instrument for T

Source§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
Source§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T> IntoEither for T

Source§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

### impl<K> IntoQueryKey<K> for K

Source§

#### fn into_query_key(self) -> K

Argument conversion from `Self` to `K`. This should always be a very cheap conversion, e.g. `LocalDefId::to_def_id`.
Source§

### impl<T> MaybeResult<T> for T

Source§

#### type Error = !

Source§

#### fn from(_: Result<T, <T as MaybeResult<T>>::Error>) -> T

Source§

#### fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>

Source§

### impl<T> Pointable for T

Source§

#### const ALIGN: usize

The alignment of pointer.
Source§

#### type Init = T

The type for initializers.
Source§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

### impl<T> Same for T

Source§

#### type Output = T

Should always be `Self`
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

### impl<I, T, U> Upcast<I, U> for T
where U: UpcastFrom<I, T>,

Source§

#### fn upcast(self, interner: I) -> U

Source§

### impl<I, T> UpcastFrom<I, T> for T

Source§

#### fn upcast_from(from: T, _tcx: I) -> T

Source§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

#### fn vzip(self) -> V

Source§

### impl<T> WithSubscriber for T

Source§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
Source§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
Source§

### impl<T> ErasedDestructor for T
where T: 'static,

## 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: 584 bytes