1 //! THIR datatypes and definitions. See the [rustc dev guide] for more info.
3 //! If you compare the THIR [`ExprKind`] to [`hir::ExprKind`], you will see it is
4 //! a good bit simpler. In fact, a number of the more straight-forward
5 //! MIR simplifications are already done in the lowering to THIR. For
6 //! example, method calls and overloaded operators are absent: they are
7 //! expected to be converted into [`ExprKind::Call`] instances.
9 //! [rustc dev guide]: https://rustc-dev-guide.rust-lang.org/thir.html
11 use rustc_ast::{InlineAsmOptions, InlineAsmTemplatePiece};
13 use rustc_hir::def::CtorKind;
14 use rustc_hir::def_id::DefId;
15 use rustc_hir::RangeEnd;
16 use rustc_index::newtype_index;
17 use rustc_index::vec::{Idx, IndexVec};
18 use rustc_middle::infer::canonical::Canonical;
19 use rustc_middle::middle::region;
20 use rustc_middle::mir::{
21 BinOp, BorrowKind, FakeReadCause, Field, Mutability, UnOp, UserTypeProjection,
23 use rustc_middle::ty::adjustment::PointerCast;
24 use rustc_middle::ty::subst::SubstsRef;
25 use rustc_middle::ty::{self, AdtDef, Const, Ty, UpvarSubsts, UserType};
26 use rustc_middle::ty::{
27 CanonicalUserType, CanonicalUserTypeAnnotation, CanonicalUserTypeAnnotations,
29 use rustc_span::{Span, Symbol, DUMMY_SP};
30 use rustc_target::abi::VariantIdx;
31 use rustc_target::asm::InlineAsmRegOrRegClass;
37 /// An index to an [`Arm`] stored in [`Thir::arms`]
45 /// An index to an [`Expr`] stored in [`Thir::exprs`]
54 /// An index to a [`Stmt`] stored in [`Thir::stmts`]
60 macro_rules! thir_with_elements {
61 ($($name:ident: $id:ty => $value:ty,)*) => {
62 /// A container for a THIR body.
64 /// This can be indexed directly by any THIR index (e.g. [`ExprId`]).
65 #[derive(Debug, HashStable)]
66 pub struct Thir<'tcx> {
68 pub $name: IndexVec<$id, $value>,
72 impl<'tcx> Thir<'tcx> {
73 pub fn new() -> Thir<'tcx> {
76 $name: IndexVec::new(),
83 impl<'tcx> Index<$id> for Thir<'tcx> {
85 fn index(&self, index: $id) -> &Self::Output {
94 arms: ArmId => Arm<'tcx>,
95 exprs: ExprId => Expr<'tcx>,
96 stmts: StmtId => Stmt<'tcx>,
99 #[derive(Copy, Clone, Debug, HashStable)]
102 Explicit(hir::HirId),
105 #[derive(Debug, HashStable)]
107 /// Whether the block itself has a label. Used by `label: {}`
108 /// and `try` blocks.
110 /// This does *not* include labels on loops, e.g. `'label: loop {}`.
111 pub targeted_by_break: bool,
112 pub region_scope: region::Scope,
113 pub opt_destruction_scope: Option<region::Scope>,
114 /// The span of the block, including the opening braces,
115 /// the label, and the `unsafe` keyword, if present.
117 /// The statements in the blocK.
118 pub stmts: Box<[StmtId]>,
119 /// The trailing expression of the block, if any.
120 pub expr: Option<ExprId>,
121 pub safety_mode: BlockSafety,
124 #[derive(Debug, HashStable)]
125 pub struct Adt<'tcx> {
126 /// The ADT we're constructing.
127 pub adt_def: &'tcx AdtDef,
128 /// The variant of the ADT.
129 pub variant_index: VariantIdx,
130 pub substs: SubstsRef<'tcx>,
132 /// Optional user-given substs: for something like `let x =
133 /// Bar::<T> { ... }`.
134 pub user_ty: Option<Canonical<'tcx, UserType<'tcx>>>,
136 pub fields: Box<[FieldExpr]>,
137 /// The base, e.g. `Foo {x: 1, .. base}`.
138 pub base: Option<FruInfo<'tcx>>,
141 #[derive(Copy, Clone, Debug, HashStable)]
142 pub enum BlockSafety {
144 /// A compiler-generated unsafe block
146 /// An `unsafe` block. The `HirId` is the ID of the block.
147 ExplicitUnsafe(hir::HirId),
150 #[derive(Debug, HashStable)]
151 pub struct Stmt<'tcx> {
152 pub kind: StmtKind<'tcx>,
153 pub opt_destruction_scope: Option<region::Scope>,
156 #[derive(Debug, HashStable)]
157 pub enum StmtKind<'tcx> {
158 /// An expression with a trailing semicolon.
160 /// The scope for this statement; may be used as lifetime of temporaries.
161 scope: region::Scope,
163 /// The expression being evaluated in this statement.
169 /// The scope for variables bound in this `let`; it covers this and
170 /// all the remaining statements in the block.
171 remainder_scope: region::Scope,
173 /// The scope for the initialization itself; might be used as
174 /// lifetime of temporaries.
175 init_scope: region::Scope,
177 /// `let <PAT> = ...`
179 /// If a type annotation is included, it is added as an ascription pattern.
182 /// `let pat: ty = <INIT>`
183 initializer: Option<ExprId>,
185 /// The lint level for this `let` statement.
186 lint_level: LintLevel,
190 // `Expr` is used a lot. Make sure it doesn't unintentionally get bigger.
191 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
192 rustc_data_structures::static_assert_size!(Expr<'_>, 104);
194 /// A THIR expression.
195 #[derive(Debug, HashStable)]
196 pub struct Expr<'tcx> {
197 /// The type of this expression
200 /// The lifetime of this expression if it should be spilled into a
201 /// temporary; should be `None` only if in a constant context
202 pub temp_lifetime: Option<region::Scope>,
204 /// span of the expression in the source
207 /// kind of expression
208 pub kind: ExprKind<'tcx>,
211 #[derive(Debug, HashStable)]
212 pub enum ExprKind<'tcx> {
213 /// `Scope`s are used to explicitely mark destruction scopes,
214 /// and to track the `HirId` of the expressions within the scope.
216 region_scope: region::Scope,
217 lint_level: LintLevel,
220 /// A `box <value>` expression.
224 /// An `if` expression.
228 else_opt: Option<ExprId>,
230 /// A function call. Method calls and overloaded operators are converted to plain function calls.
232 /// The type of the function. This is often a [`FnDef`] or a [`FnPtr`].
234 /// [`FnDef`]: ty::TyKind::FnDef
235 /// [`FnPtr`]: ty::TyKind::FnPtr
237 /// The function itself.
239 /// The arguments passed to the function.
241 /// Note: in some cases (like calling a closure), the function call `f(...args)` gets
242 /// rewritten as a call to a function trait method (e.g. `FnOnce::call_once(f, (...args))`).
244 /// Whether this is from an overloaded operator rather than a
245 /// function call from HIR. `true` for overloaded function call.
247 /// The span of the function, without the dot and receiver
248 /// (e.g. `foo(a, b)` in `x.foo(a, b)`).
251 /// A *non-overloaded* dereference.
255 /// A *non-overloaded* binary operation.
261 /// A logical operation. This is distinct from `BinaryOp` because
262 /// the operands need to be lazily evaluated.
268 /// A *non-overloaded* unary operation. Note that here the deref (`*`)
269 /// operator is represented by `ExprKind::Deref`.
274 /// A cast: `<source> as <type>`. The type we cast to is the type of
275 /// the parent expression.
281 }, // Use a lexpr to get a vexpr.
282 /// A coercion from `!` to any type.
286 /// A pointer cast. More information can be found in [`PointerCast`].
291 /// A `loop` expression.
295 /// A `match` expression.
304 /// An assignment: `lhs = rhs`.
309 /// A *non-overloaded* operation assignment, e.g. `lhs += rhs`.
315 /// Access to a struct or tuple field.
318 /// This can be a named (`.foo`) or unnamed (`.0`) field.
321 /// A *non-overloaded* indexing operation.
326 /// A local variable.
330 /// Used to represent upvars mentioned in a closure/generator
332 /// DefId of the closure/generator
333 closure_def_id: DefId,
335 /// HirId of the root variable
336 var_hir_id: hir::HirId,
338 /// A borrow, e.g. `&arg`.
340 borrow_kind: BorrowKind,
343 /// A `&raw [const|mut] $place_expr` raw borrow resulting in type `*[const|mut] T`.
345 mutability: hir::Mutability,
348 /// A `break` expression.
350 label: region::Scope,
351 value: Option<ExprId>,
353 /// A `continue` expression.
355 label: region::Scope,
357 /// A `return` expression.
359 value: Option<ExprId>,
361 /// An inline `const` block, e.g. `const {}`.
363 value: &'tcx Const<'tcx>,
365 /// An array literal constructed from one repeated element, e.g. `[1; 5]`.
368 count: &'tcx Const<'tcx>,
370 /// An array, e.g. `[a, b, c, d]`.
372 fields: Box<[ExprId]>,
374 /// A tuple, e.g. `(a, b, c, d)`.
376 fields: Box<[ExprId]>,
378 /// An ADT constructor, e.g. `Foo {x: 1, y: 2}`.
380 /// A type ascription on a place.
381 PlaceTypeAscription {
383 /// Type that the user gave to this expression
384 user_ty: Option<Canonical<'tcx, UserType<'tcx>>>,
386 /// A type ascription on a value, e.g. `42: i32`.
387 ValueTypeAscription {
389 /// Type that the user gave to this expression
390 user_ty: Option<Canonical<'tcx, UserType<'tcx>>>,
392 /// A closure definition.
395 substs: UpvarSubsts<'tcx>,
396 upvars: Box<[ExprId]>,
397 movability: Option<hir::Movability>,
398 fake_reads: Vec<(ExprId, FakeReadCause, hir::HirId)>,
402 literal: &'tcx Const<'tcx>,
403 user_ty: Option<Canonical<'tcx, UserType<'tcx>>>,
404 /// The `DefId` of the `const` item this literal
405 /// was produced from, if this is not a user-written
407 const_id: Option<DefId>,
409 /// A literal containing the address of a `static`.
411 /// This is only distinguished from `Literal` so that we can register some
412 /// info for diagnostics.
414 literal: &'tcx Const<'tcx>,
417 /// Inline assembly, i.e. `asm!()`.
419 template: &'tcx [InlineAsmTemplatePiece],
420 operands: Box<[InlineAsmOperand<'tcx>]>,
421 options: InlineAsmOptions,
422 line_spans: &'tcx [Span],
424 /// An expression taking a reference to a thread local.
425 ThreadLocalRef(DefId),
426 /// Inline LLVM assembly, i.e. `llvm_asm!()`.
428 asm: &'tcx hir::LlvmInlineAsmInner,
429 outputs: Box<[ExprId]>,
430 inputs: Box<[ExprId]>,
432 /// A `yield` expression.
438 /// Represents the association of a field identifier and an expression.
440 /// This is used in struct constructors.
441 #[derive(Debug, HashStable)]
442 pub struct FieldExpr {
447 #[derive(Debug, HashStable)]
448 pub struct FruInfo<'tcx> {
450 pub field_types: Box<[Ty<'tcx>]>,
454 #[derive(Debug, HashStable)]
455 pub struct Arm<'tcx> {
456 pub pattern: Pat<'tcx>,
457 pub guard: Option<Guard<'tcx>>,
459 pub lint_level: LintLevel,
460 pub scope: region::Scope,
465 #[derive(Debug, HashStable)]
466 pub enum Guard<'tcx> {
468 IfLet(Pat<'tcx>, ExprId),
471 #[derive(Copy, Clone, Debug, HashStable)]
473 /// The `&&` operator.
475 /// The `||` operator.
479 #[derive(Debug, HashStable)]
480 pub enum InlineAsmOperand<'tcx> {
482 reg: InlineAsmRegOrRegClass,
486 reg: InlineAsmRegOrRegClass,
488 expr: Option<ExprId>,
491 reg: InlineAsmRegOrRegClass,
496 reg: InlineAsmRegOrRegClass,
499 out_expr: Option<ExprId>,
502 value: &'tcx Const<'tcx>,
513 #[derive(Copy, Clone, Debug, PartialEq, HashStable)]
514 pub enum BindingMode {
519 #[derive(Clone, Debug, PartialEq, HashStable)]
520 pub struct FieldPat<'tcx> {
522 pub pattern: Pat<'tcx>,
525 #[derive(Clone, Debug, PartialEq, HashStable)]
526 pub struct Pat<'tcx> {
529 pub kind: Box<PatKind<'tcx>>,
532 impl<'tcx> Pat<'tcx> {
533 pub fn wildcard_from_ty(ty: Ty<'tcx>) -> Self {
534 Pat { ty, span: DUMMY_SP, kind: Box::new(PatKind::Wild) }
538 #[derive(Copy, Clone, Debug, PartialEq, HashStable)]
539 pub struct PatTyProj<'tcx> {
540 pub user_ty: CanonicalUserType<'tcx>,
543 impl<'tcx> PatTyProj<'tcx> {
544 pub fn from_user_type(user_annotation: CanonicalUserType<'tcx>) -> Self {
545 Self { user_ty: user_annotation }
550 annotations: &mut CanonicalUserTypeAnnotations<'tcx>,
551 inferred_ty: Ty<'tcx>,
553 ) -> UserTypeProjection {
555 base: annotations.push(CanonicalUserTypeAnnotation {
557 user_ty: self.user_ty,
565 #[derive(Copy, Clone, Debug, PartialEq, HashStable)]
566 pub struct Ascription<'tcx> {
567 pub user_ty: PatTyProj<'tcx>,
568 /// Variance to use when relating the type `user_ty` to the **type of the value being
569 /// matched**. Typically, this is `Variance::Covariant`, since the value being matched must
570 /// have a type that is some subtype of the ascribed type.
572 /// Note that this variance does not apply for any bindings within subpatterns. The type
573 /// assigned to those bindings must be exactly equal to the `user_ty` given here.
575 /// The only place where this field is not `Covariant` is when matching constants, where
576 /// we currently use `Contravariant` -- this is because the constant type just needs to
577 /// be "comparable" to the type of the input value. So, for example:
580 /// match x { "foo" => .. }
583 /// requires that `&'static str <: T_x`, where `T_x` is the type of `x`. Really, we should
584 /// probably be checking for a `PartialEq` impl instead, but this preserves the behavior
585 /// of the old type-check for now. See #57280 for details.
586 pub variance: ty::Variance,
587 pub user_ty_span: Span,
590 #[derive(Clone, Debug, PartialEq, HashStable)]
591 pub enum PatKind<'tcx> {
592 /// A wildward pattern: `_`.
596 ascription: Ascription<'tcx>,
597 subpattern: Pat<'tcx>,
600 /// `x`, `ref x`, `x @ P`, etc.
602 mutability: Mutability,
607 subpattern: Option<Pat<'tcx>>,
608 /// Is this the leftmost occurrence of the binding, i.e., is `var` the
609 /// `HirId` of this pattern?
613 /// `Foo(...)` or `Foo{...}` or `Foo`, where `Foo` is a variant name from an ADT with
614 /// multiple variants.
616 adt_def: &'tcx AdtDef,
617 substs: SubstsRef<'tcx>,
618 variant_index: VariantIdx,
619 subpatterns: Vec<FieldPat<'tcx>>,
622 /// `(...)`, `Foo(...)`, `Foo{...}`, or `Foo`, where `Foo` is a variant name from an ADT with
623 /// a single variant.
625 subpatterns: Vec<FieldPat<'tcx>>,
628 /// `box P`, `&P`, `&mut P`, etc.
630 subpattern: Pat<'tcx>,
633 /// One of the following:
634 /// * `&str`, which will be handled as a string pattern and thus exhaustiveness
635 /// checking will detect if you use the same string twice in different patterns.
636 /// * integer, bool, char or float, which will be handled by exhaustivenes to cover exactly
637 /// its own value, similar to `&str`, but these values are much simpler.
638 /// * Opaque constants, that must not be matched structurally. So anything that does not derive
639 /// `PartialEq` and `Eq`.
641 value: &'tcx ty::Const<'tcx>,
644 Range(PatRange<'tcx>),
646 /// Matches against a slice, checking the length and extracting elements.
647 /// irrefutable when there is a slice pattern and both `prefix` and `suffix` are empty.
648 /// e.g., `&[ref xs @ ..]`.
650 prefix: Vec<Pat<'tcx>>,
651 slice: Option<Pat<'tcx>>,
652 suffix: Vec<Pat<'tcx>>,
655 /// Fixed match against an array; irrefutable.
657 prefix: Vec<Pat<'tcx>>,
658 slice: Option<Pat<'tcx>>,
659 suffix: Vec<Pat<'tcx>>,
662 /// An or-pattern, e.g. `p | q`.
663 /// Invariant: `pats.len() >= 2`.
665 pats: Vec<Pat<'tcx>>,
669 #[derive(Copy, Clone, Debug, PartialEq, HashStable)]
670 pub struct PatRange<'tcx> {
671 pub lo: &'tcx ty::Const<'tcx>,
672 pub hi: &'tcx ty::Const<'tcx>,
676 impl<'tcx> fmt::Display for Pat<'tcx> {
677 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
678 // Printing lists is a chore.
679 let mut first = true;
680 let mut start_or_continue = |s| {
688 let mut start_or_comma = || start_or_continue(", ");
691 PatKind::Wild => write!(f, "_"),
692 PatKind::AscribeUserType { ref subpattern, .. } => write!(f, "{}: _", subpattern),
693 PatKind::Binding { mutability, name, mode, ref subpattern, .. } => {
694 let is_mut = match mode {
695 BindingMode::ByValue => mutability == Mutability::Mut,
696 BindingMode::ByRef(bk) => {
698 matches!(bk, BorrowKind::Mut { .. })
704 write!(f, "{}", name)?;
705 if let Some(ref subpattern) = *subpattern {
706 write!(f, " @ {}", subpattern)?;
710 PatKind::Variant { ref subpatterns, .. } | PatKind::Leaf { ref subpatterns } => {
711 let variant = match *self.kind {
712 PatKind::Variant { adt_def, variant_index, .. } => {
713 Some(&adt_def.variants[variant_index])
716 if let ty::Adt(adt, _) = self.ty.kind() {
718 Some(&adt.variants[VariantIdx::new(0)])
728 if let Some(variant) = variant {
729 write!(f, "{}", variant.ident)?;
731 // Only for Adt we can have `S {...}`,
732 // which we handle separately here.
733 if variant.ctor_kind == CtorKind::Fictive {
737 for p in subpatterns {
738 if let PatKind::Wild = *p.pattern.kind {
741 let name = variant.fields[p.field.index()].ident;
742 write!(f, "{}{}: {}", start_or_comma(), name, p.pattern)?;
746 if printed < variant.fields.len() {
747 write!(f, "{}..", start_or_comma())?;
750 return write!(f, " }}");
754 let num_fields = variant.map_or(subpatterns.len(), |v| v.fields.len());
755 if num_fields != 0 || variant.is_none() {
757 for i in 0..num_fields {
758 write!(f, "{}", start_or_comma())?;
760 // Common case: the field is where we expect it.
761 if let Some(p) = subpatterns.get(i) {
762 if p.field.index() == i {
763 write!(f, "{}", p.pattern)?;
768 // Otherwise, we have to go looking for it.
769 if let Some(p) = subpatterns.iter().find(|p| p.field.index() == i) {
770 write!(f, "{}", p.pattern)?;
780 PatKind::Deref { ref subpattern } => {
781 match self.ty.kind() {
782 ty::Adt(def, _) if def.is_box() => write!(f, "box ")?,
783 ty::Ref(_, _, mutbl) => {
784 write!(f, "&{}", mutbl.prefix_str())?;
786 _ => bug!("{} is a bad Deref pattern type", self.ty),
788 write!(f, "{}", subpattern)
790 PatKind::Constant { value } => write!(f, "{}", value),
791 PatKind::Range(PatRange { lo, hi, end }) => {
792 write!(f, "{}", lo)?;
793 write!(f, "{}", end)?;
796 PatKind::Slice { ref prefix, ref slice, ref suffix }
797 | PatKind::Array { ref prefix, ref slice, ref suffix } => {
800 write!(f, "{}{}", start_or_comma(), p)?;
802 if let Some(ref slice) = *slice {
803 write!(f, "{}", start_or_comma())?;
806 _ => write!(f, "{}", slice)?,
811 write!(f, "{}{}", start_or_comma(), p)?;
815 PatKind::Or { ref pats } => {
817 write!(f, "{}{}", start_or_continue(" | "), pat)?;