Module rustc_middle::mir

MIR datatypes and passes. See the rustc dev guide for more info.

Re-exports

• pub use self::graphviz::write_mir_graphviz;
• pub use self::pretty::create_dump_file;
• pub use self::pretty::display_allocation;
• pub use self::pretty::dump_enabled;
• pub use self::pretty::dump_mir;
• pub use self::pretty::write_mir_pretty;
• pub use self::pretty::PassWhere;

Modules

• basic_blocks 🔒
• binding_form_impl 🔒
• consts 🔒
• coverage
  Metadata from source code coverage analysis and instrumentation.
• generic_graph 🔒
• generic_graphviz
• graphviz
• interpret
  An interpreter for MIR used in CTFE and by miri.
• mono
• patch
• pretty
• query 🔒
  Values computed by queries that use MIR.
• size_asserts 🔒
• statement 🔒
  Functionality for statements, operands, places, and things that appear in them.
• syntax 🔒
  This defines the syntax of MIR, i.e., the set of available MIR operations, and other definitions closely related to MIR semantics. This is in a dedicated file so that changes to this file can be reviewed more carefully. The intention is that this file only contains datatype declarations, no code.
• tcx
  Methods for the various MIR types. These are intended for use after building is complete.
• terminator 🔒
  Functionality for terminators and helper types that appear in terminators.
• traversal
• type_foldable 🔒
  TypeFoldable implementations for MIR types
• visit
  The MIR Visitor

Structs

• BasicBlock
  A node in the MIR control-flow graph.
• BasicBlockData
  Data for a basic block, including a list of its statements.
• BasicBlocks
• BlockTailInfo
  BlockTailInfo is attached to the LocalDecl for temporaries created during evaluation of expressions in a block tail expression; that is, a block like { STMT_1; STMT_2; EXPR }.
• Body
  The lowered representation of a single function.
• BorrowCheckResult
• ClosureOutlivesRequirement
  Indicates an outlives-constraint between a type or between two free regions declared on the closure.
• ClosureOutlivesSubjectTy
  Represents a ty::Ty for use in ClosureOutlivesSubject.
• ClosureRegionRequirements
  After we borrow check a closure, we are left with various requirements that we have inferred between the free regions that appear in the closure’s signature or on its field types. These requirements are then verified and proved by the closure’s creating function. This struct encodes those requirements.
• ConstAlloc
  Evaluated Constants Represents the result of const evaluation via the eval_to_allocation query. Not to be confused with ConstAllocation, which directly refers to the underlying data! Here we indirect via an AllocId.
• ConstOperand
• ConstQualifs
  The result of the mir_const_qualif query.
• CopyNonOverlapping
• CoroutineInfo
  Additional information carried by a MIR body when it is lowered from a coroutine. This information is modified as it is lowered during the StateTransform MIR pass, so not all fields will be active at a given time. For example, the yield_ty is taken out of the field after yields are turned into returns, and the coroutine_drop body is only populated after the state transform pass.
• CoroutineLayout
  The layout of coroutine state.
• CoroutineSavedLocal
• CoroutineSavedTy
• CoverageIdsInfo
  Summarizes coverage IDs inserted by the InstrumentCoverage MIR pass (for compiler option -Cinstrument-coverage), after MIR optimizations have had a chance to potentially remove some of them.
• DestructuredConstant
  The constituent parts of a mir constant of kind ADT or array.
• Local
• LocalDecl
  A MIR local.
• Location
  Location represents the position of the start of the statement; or, if statement_index equals the number of statements, then the start of the terminator.
• MirSource
  Where a specific mir::Body comes from.
• Place
  Places roughly correspond to a “location in memory.” Places in MIR are the same mathematical object as places in Rust. This of course means that what exactly they are is undecided and part of the Rust memory model. However, they will likely contain at least the following pieces of information in some form:
• PlaceRef
• Promoted
• SourceInfo
  Grouped information about the source code origin of a MIR entity. Intended to be inspected by diagnostics and debuginfo. Most passes can work with it as a whole, within a single function.
• SourceScope
• SourceScopeData
• SourceScopeLocalData
• Statement
  A statement in a basic block, including information about its source code.
• SwitchTargets
• SwitchTargetsIter
• Terminator
• UnevaluatedConst
  An unevaluated (potentially generic) constant used in MIR.
• UserTypeProjection
  Encodes the effect of a user-supplied type annotation on the subcomponents of a pattern. The effect is determined by applying the given list of projections to some underlying base type. Often, the projection element list projs is empty, in which case this directly encodes a type in base. But in the case of complex patterns with subpatterns and bindings, we want to apply only a part of the type to a variable, in which case the projs vector is used.
• UserTypeProjections
  A collection of projections into user types.
• VarBindingForm
• VarDebugInfo
  Debug information pertaining to a user variable.
• VarDebugInfoFragment

Enums

• AggregateKind
• AnalysisPhase
  See MirPhase::Analysis.
• AssertKind
  Information about an assertion failure.
• BinOp
• BindingForm
• BorrowKind
• CallReturnPlaces
  List of places that are written to after a successful (non-unwind) return from a Call, Yield or InlineAsm.
• CallSource
  Represents how a TerminatorKind::Call was constructed, used for diagnostics
• CastKind
• ClearCrossCrate
• ClosureOutlivesSubject
  The subject of a ClosureOutlivesRequirement – that is, the thing that must outlive some region.
• Const
  Constants
• ConstValue
  Represents a constant value in Rust. Scalar and Slice are optimizations for array length computations, enum discriminants and the pattern matching logic.
• ConstraintCategory
  Outlives-constraints can be categorized to determine whether and why they are interesting (for error reporting). Order of variants indicates sort order of the category, thereby influencing diagnostic output.
• DefLocation
  DefLocation represents the location of a definition - either an argument or an assignment within MIR body.
• FakeBorrowKind
• FakeReadCause
  The FakeReadCause describes the type of pattern why a FakeRead statement exists.
• InlineAsmOperand
• LocalInfo
  Extra information about a some locals that’s used for diagnostics and for classifying variables into local variables, statics, etc, which is needed e.g. for borrow checking.
• LocalKind
  Classifies locals into categories. See Body::local_kind.
• MentionedItem
  Some item that needs to monomorphize successfully for a MIR body to be considered well-formed.
• MirPhase
  Represents the “flavors” of MIR.
• MutBorrowKind
• Mutability
• NonDivergingIntrinsic
• NullOp
• Operand
  An operand in MIR represents a “value” in Rust, the definition of which is undecided and part of the memory model. One proposal for a definition of values can be found on UCG.
• ProjectionElem
• RetagKind
  Describes what kind of retag is to be performed.
• ReturnConstraint
• RuntimePhase
  See MirPhase::Runtime.
• Rvalue
  The various kinds of rvalues that can appear in MIR.
• StatementKind
  The various kinds of statements that can appear in MIR.
• TerminatorEdges
• TerminatorKind
  The various kinds of terminators, representing ways of exiting from a basic block.
• UnOp
• UnwindAction
  Action to be taken when a stack unwind happens.
• UnwindTerminateReason
  The reason we are terminating the process during unwinding.
• VarDebugInfoContents

Constants

• OUTERMOST_SOURCE_SCOPE
• PASS_NAMES 🔒
• RETURN_PLACE
• START_BLOCK
• TAG_CLEAR_CROSS_CRATE_CLEAR 🔒
• TAG_CLEAR_CROSS_CRATE_SET 🔒

Traits

• HasLocalDecls
• MirPass
  A streamlined trait that you can implement to create a pass; the pass will be named after the type, and it will consist of a main loop that goes over each available MIR and applies run_pass.

Functions

• graphviz_safe_def_name
• to_profiler_name 🔒
  Converts a MIR pass name into a snake case form to match the profiling naming style.

Type Aliases

• AssertMessage
  Type for MIR Assert terminator error messages.
• LocalDecls
  Types for locals
• PlaceElem
  Alias for projections as they appear in places, where the base is a place and the index is a local.
• ProjectionKind
  Alias for projections as they appear in UserTypeProjection, where we need neither the V parameter for Index nor the T for Field.
• Successors
• SuccessorsMut