Operations

• Operations
  • cir.acos (::cir::ACosOp)
    • Operands:
    • Results:
  • cir.asin (::cir::ASinOp)
    • Operands:
    • Results:
  • cir.atan (::cir::ATanOp)
    • Operands:
    • Results:
  • cir.abs (::cir::AbsOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.alloc.exception (::cir::AllocExceptionOp)
    • Attributes:
    • Results:
  • cir.alloca (::cir::AllocaOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.array.ctor (::cir::ArrayCtor)
    • Operands:
  • cir.array.dtor (::cir::ArrayDtor)
    • Operands:
  • cir.assume.aligned (::cir::AssumeAlignedOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.assume (::cir::AssumeOp)
    • Operands:
  • cir.assume.separate_storage (::cir::AssumeSepStorageOp)
    • Operands:
  • cir.atomic.cmp_xchg (::cir::AtomicCmpXchg)
    • Attributes:
    • Operands:
    • Results:
  • cir.atomic.fence (::cir::AtomicFence)
    • Attributes:
  • cir.atomic.fetch (::cir::AtomicFetch)
    • Attributes:
    • Operands:
    • Results:
  • cir.atomic.xchg (::cir::AtomicXchg)
    • Attributes:
    • Operands:
    • Results:
  • cir.await (::cir::AwaitOp)
    • Attributes:
  • cir.base_class_addr (::cir::BaseClassAddrOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.base_data_member (::cir::BaseDataMemberOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.base_method (::cir::BaseMethodOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.binop (::cir::BinOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.binop.overflow (::cir::BinOpOverflowOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.bit.clrsb (::cir::BitClrsbOp)
    • Operands:
    • Results:
  • cir.bit.clz (::cir::BitClzOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.bit.ctz (::cir::BitCtzOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.bit.ffs (::cir::BitFfsOp)
    • Operands:
    • Results:
  • cir.bit.parity (::cir::BitParityOp)
    • Operands:
    • Results:
  • cir.bit.popcount (::cir::BitPopcountOp)
    • Operands:
    • Results:
  • cir.bit_reverse (::cir::BitReverseOp)
    • Operands:
    • Results:
  • cir.brcond (::cir::BrCondOp)
    • Operands:
    • Successors:
  • cir.br (::cir::BrOp)
    • Operands:
    • Successors:
  • cir.break (::cir::BreakOp)
  • cir.bswap (::cir::ByteswapOp)
    • Operands:
    • Results:
  • cir.asm (::cir::InlineAsmOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.call (::cir::CallOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.case (::cir::CaseOp)
    • Attributes:
  • cir.cast (::cir::CastOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.catch_param (::cir::CatchParamOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.ceil (::cir::CeilOp)
    • Operands:
    • Results:
  • cir.clear_cache (::cir::ClearCacheOp)
    • Operands:
  • cir.cmp (::cir::CmpOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.cmp3way (::cir::CmpThreeWayOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.complex.binop (::cir::ComplexBinOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.complex.create (::cir::ComplexCreateOp)
    • Operands:
    • Results:
  • cir.complex.imag (::cir::ComplexImagOp)
    • Operands:
    • Results:
  • cir.complex.imag_ptr (::cir::ComplexImagPtrOp)
    • Operands:
    • Results:
  • cir.complex.real (::cir::ComplexRealOp)
    • Operands:
    • Results:
  • cir.complex.real_ptr (::cir::ComplexRealPtrOp)
    • Operands:
    • Results:
  • cir.condition (::cir::ConditionOp)
    • Operands:
  • cir.const (::cir::ConstantOp)
    • Attributes:
    • Results:
  • cir.continue (::cir::ContinueOp)
  • cir.copy (::cir::CopyOp)
    • Attributes:
    • Operands:
  • cir.copysign (::cir::CopysignOp)
    • Operands:
    • Results:
  • cir.cos (::cir::CosOp)
    • Operands:
    • Results:
  • cir.delete.array (::cir::DeleteArrayOp)
    • Operands:
  • cir.derived_class_addr (::cir::DerivedClassAddrOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.derived_data_member (::cir::DerivedDataMemberOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.derived_method (::cir::DerivedMethodOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.do (::cir::DoWhileOp)
  • cir.dyn_cast (::cir::DynamicCastOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.eh.inflight_exception (::cir::EhInflightOp)
    • Attributes:
    • Results:
  • cir.eh.typeid (::cir::EhTypeIdOp)
    • Attributes:
    • Results:
  • cir.exp2 (::cir::Exp2Op)
    • Operands:
    • Results:
  • cir.exp (::cir::ExpOp)
    • Operands:
    • Results:
  • cir.expect (::cir::ExpectOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.extract_member (::cir::ExtractMemberOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.fabs (::cir::FAbsOp)
    • Operands:
    • Results:
  • cir.fmaxnum (::cir::FMaxNumOp)
    • Operands:
    • Results:
  • cir.fmaximum (::cir::FMaximumOp)
    • Operands:
    • Results:
  • cir.fminnum (::cir::FMinNumOp)
    • Operands:
    • Results:
  • cir.fminimum (::cir::FMinimumOp)
    • Operands:
    • Results:
  • cir.fmod (::cir::FModOp)
    • Operands:
    • Results:
  • cir.floor (::cir::FloorOp)
    • Operands:
    • Results:
  • cir.for (::cir::ForOp)
  • cir.frame_address (::cir::FrameAddrOp)
    • Operands:
    • Results:
  • cir.free.exception (::cir::FreeExceptionOp)
    • Operands:
  • cir.func (::cir::FuncOp)
    • Attributes:
  • cir.get_bitfield (::cir::GetBitfieldOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.get_global (::cir::GetGlobalOp)
    • Attributes:
    • Results:
  • cir.get_member (::cir::GetMemberOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.get_method (::cir::GetMethodOp)
    • Operands:
    • Results:
  • cir.get_runtime_member (::cir::GetRuntimeMemberOp)
    • Operands:
    • Results:
  • cir.global (::cir::GlobalOp)
    • Attributes:
  • cir.goto (::cir::GotoOp)
    • Attributes:
  • cir.if (::cir::IfOp)
    • Operands:
  • cir.insert_member (::cir::InsertMemberOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.invariant_group (::cir::InvariantGroupOp)
    • Operands:
    • Results:
  • cir.is_constant (::cir::IsConstantOp)
    • Operands:
    • Results:
  • cir.is_fp_class (::cir::IsFPClassOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.std.begin (::cir::IterBeginOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.std.end (::cir::IterEndOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.llvm.intrinsic (::cir::LLVMIntrinsicCallOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.llrint (::cir::LLrintOp)
    • Operands:
    • Results:
  • cir.llround (::cir::LLroundOp)
    • Operands:
    • Results:
  • cir.label (::cir::LabelOp)
    • Attributes:
  • cir.linker_options (::cir::LinkerOptionsOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.log10 (::cir::Log10Op)
    • Operands:
    • Results:
  • cir.log2 (::cir::Log2Op)
    • Operands:
    • Results:
  • cir.log (::cir::LogOp)
    • Operands:
    • Results:
  • cir.lrint (::cir::LrintOp)
    • Operands:
    • Results:
  • cir.lround (::cir::LroundOp)
    • Operands:
    • Results:
  • cir.libc.memchr (::cir::MemChrOp)
    • Operands:
    • Results:
  • cir.memcpy_inline (::cir::MemCpyInlineOp)
    • Attributes:
    • Operands:
  • cir.libc.memcpy (::cir::MemCpyOp)
    • Operands:
  • cir.libc.memmove (::cir::MemMoveOp)
    • Operands:
  • cir.memset_inline (::cir::MemSetInlineOp)
    • Attributes:
    • Operands:
  • cir.libc.memset (::cir::MemSetOp)
    • Operands:
  • cir.nearbyint (::cir::NearbyintOp)
    • Operands:
    • Results:
  • cir.objsize (::cir::ObjSizeOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.pow (::cir::PowOp)
    • Operands:
    • Results:
  • cir.prefetch (::cir::PrefetchOp)
    • Attributes:
    • Operands:
  • cir.ptr_diff (::cir::PtrDiffOp)
    • Operands:
    • Results:
  • cir.ptr_mask (::cir::PtrMaskOp)
    • Operands:
    • Results:
  • cir.ptr_stride (::cir::PtrStrideOp)
    • Operands:
    • Results:
  • cir.resume (::cir::ResumeOp)
    • Operands:
    • Results:
  • cir.return (::cir::ReturnOp)
    • Operands:
  • cir.rint (::cir::RintOp)
    • Operands:
    • Results:
  • cir.rotate (::cir::RotateOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.roundeven (::cir::RoundEvenOp)
    • Operands:
    • Results:
  • cir.round (::cir::RoundOp)
    • Operands:
    • Results:
  • cir.scope (::cir::ScopeOp)
    • Results:
  • cir.select (::cir::SelectOp)
    • Operands:
    • Results:
  • cir.set_bitfield (::cir::SetBitfieldOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.shift (::cir::ShiftOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.signbit (::cir::SignBitOp)
    • Operands:
    • Results:
  • cir.sin (::cir::SinOp)
    • Operands:
    • Results:
  • cir.sqrt (::cir::SqrtOp)
    • Operands:
    • Results:
  • cir.stack_restore (::cir::StackRestoreOp)
    • Operands:
  • cir.stack_save (::cir::StackSaveOp)
    • Results:
  • cir.std.find (::cir::StdFindOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.store (::cir::StoreOp)
    • Attributes:
    • Operands:
  • cir.switch.flat (::cir::SwitchFlatOp)
    • Attributes:
    • Operands:
    • Successors:
  • cir.switch (::cir::SwitchOp)
    • Operands:
  • cir.tan (::cir::TanOp)
    • Operands:
    • Results:
  • cir.ternary (::cir::TernaryOp)
    • Operands:
    • Results:
  • cir.throw (::cir::ThrowOp)
    • Attributes:
    • Operands:
  • cir.trap (::cir::TrapOp)
  • cir.trunc (::cir::TruncOp)
    • Operands:
    • Results:
  • cir.try_call (::cir::TryCallOp)
    • Attributes:
    • Operands:
    • Results:
    • Successors:
  • cir.try (::cir::TryOp)
    • Attributes:
  • cir.unary (::cir::UnaryOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.unreachable (::cir::UnreachableOp)
  • cir.va.arg (::cir::VAArgOp)
    • Operands:
    • Results:
  • cir.va.copy (::cir::VACopyOp)
    • Operands:
  • cir.va.end (::cir::VAEndOp)
    • Operands:
  • cir.va.start (::cir::VAStartOp)
    • Operands:
  • cir.vtt.address_point (::cir::VTTAddrPointOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.vtable.address_point (::cir::VTableAddrPointOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.vec.cmp (::cir::VecCmpOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.vec.create (::cir::VecCreateOp)
    • Operands:
    • Results:
  • cir.vec.extract (::cir::VecExtractOp)
    • Operands:
    • Results:
  • cir.vec.insert (::cir::VecInsertOp)
    • Operands:
    • Results:
  • cir.vec.shuffle.dynamic (::cir::VecShuffleDynamicOp)
    • Operands:
    • Results:
  • cir.vec.shuffle (::cir::VecShuffleOp)
    • Attributes:
    • Operands:
    • Results:
  • cir.vec.splat (::cir::VecSplatOp)
    • Operands:
    • Results:
  • cir.vec.ternary (::cir::VecTernaryOp)
    • Operands:
    • Results:
  • cir.while (::cir::WhileOp)
  • cir.yield (::cir::YieldOp)
    • Operands:

cir.acos (::cir::ACosOp)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.acos` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.asin (::cir::ASinOp)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.asin` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.atan (::cir::ATanOp)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.atan` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.abs (::cir::AbsOp)

_Libc builtin equivalent abs, labs, llabs

The `poison` argument indicate whether the result value
is a poison value if the first argument is statically or
dynamically an INT_MIN value.

Example:

```mlir
  %0 = cir.const #cir.int<-42> : s32i
  %1 = cir.abs %0 poison : s32i
  %2 = cir.abs %3 : !cir.vector<!s32i x 4>
```_

Syntax:

operation ::= `cir.abs` $src ( `poison` $poison^ )? `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.alloc.exception (::cir::AllocExceptionOp)

Allocates an exception according to Itanium ABI

Syntax:

operation ::= `cir.alloc.exception` $size `->` qualified(type($addr)) attr-dict

Implements a slightly higher level __cxa_allocate_exception:

void *__cxa_allocate_exception(size_t thrown_size);

If operation fails, program terminates, not throw.

Example:

// if (b == 0) {
//   ...
//   throw "...";
cir.if %10 {
    %11 = cir.alloc_exception 8 -> !cir.ptr<!void>
    ... // store exception content into %11
    cir.throw %11 : !cir.ptr<!cir.ptr<!u8i>>, ...

Attributes:

Results:

cir.alloca (::cir::AllocaOp)

Defines a scope-local variable

Syntax:

operation ::= `cir.alloca` $allocaType `,` qualified(type($addr)) `,`
              ($dynAllocSize^ `:` type($dynAllocSize) `,`)?
              `[` $name
              (`,` `init` $init^)?
              (`,` `const` $constant^)?
              `]`
              ($annotations^)?
              (`ast` $ast^)? attr-dict

The cir.alloca operation defines a scope-local variable.

The presence init attribute indicates that the local variable represented by this alloca was originally initialized in C/C++ source code. In such cases, the first use contains the initialization (a cir.store, a cir.call to a ctor, etc).

The presence of the const attribute indicates that the local variable is declared with C/C++ const keyword.

The dynAllocSize specifies the size to dynamically allocate on the stack and ignores the allocation size based on the original type. This is useful when handling VLAs and is omitted when declaring regular local variables.

The result type is a pointer to the input's type.

Example:

// int count = 3;
%0 = cir.alloca i32, !cir.ptr<i32>, ["count", init] {alignment = 4 : i64}

// int *ptr;
%1 = cir.alloca !cir.ptr<i32>, !cir.ptr<!cir.ptr<i32>>, ["ptr"] {alignment = 8 : i64}
...

Interfaces: PromotableAllocationOpInterface

Attributes:

Operands:

Results:

cir.array.ctor (::cir::ArrayCtor)

Initialize array elements with C++ constructors

Syntax:

operation ::= `cir.array.ctor` `(` $addr `:` qualified(type($addr)) `)` $body attr-dict

Initialize each array element using the same C++ constructor. This operation has one region, with one single block. The block has an incoming argument for the current array index to initialize.

Operands:

cir.array.dtor (::cir::ArrayDtor)

Destroy array elements with C++ dtors

Syntax:

operation ::= `cir.array.dtor` `(` $addr `:` qualified(type($addr)) `)` $body attr-dict

Destroy each array element using the same C++ destructor. This operation has one region, with one single block. The block has an incoming argument for the current array index to initialize.

Operands:

cir.assume.aligned (::cir::AssumeAlignedOp)

Tell the optimizer that a pointer is aligned

Syntax:

operation ::= `cir.assume.aligned` $pointer `:` qualified(type($pointer))
              `[` `alignment` $alignment (`,` `offset` $offset^ `:` type($offset))? `]`
              attr-dict

The cir.assume.aligned operation takes two or three arguments.

When the 3rd argument offset is absent, this operation tells the optimizer that the pointer given by the pointer argument is aligned to the alignment given by the align argument.

When the offset argument is given, it represents an offset from the alignment. This operation then tells the optimizer that the pointer given by the pointer argument is always misaligned by the alignment given by the align argument by offset bytes, a.k.a. the pointer yielded by (char *)pointer - offset is aligned to the specified alignment.

The align argument is a constant integer represented as an integer attribute instead of an SSA value. It must be a positive integer.

The result of this operation has the same value as the pointer argument, but the optimizer has additional knowledge about its alignment.

This operation corresponds to the __builtin_assume_aligned builtin function.

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.assume (::cir::AssumeOp)

Tell the optimizer that a boolean value is true

Syntax:

operation ::= `cir.assume` $predicate `:` type($predicate) attr-dict

The cir.assume operation takes a single boolean prediate as its only argument and does not have any results. The operation tells the optimizer that the predicate's value is true.

This operation corresponds to the __assume and the __builtin_assume builtin function.

Operands:

cir.assume.separate_storage (::cir::AssumeSepStorageOp)

Tell the optimizer that two pointers point to different allocations

Syntax:

operation ::= `cir.assume.separate_storage` $ptr1 `,` $ptr2 `:` qualified(type($ptr1)) attr-dict

The cir.assume.separate_storage operation takes two pointers as arguments, and the operation tells the optimizer that these two pointers point to different allocations.

This operation corresponds to the __builtin_assume_separate_storage builtin function.

Traits: SameTypeOperands

Operands:

cir.atomic.cmp_xchg (::cir::AtomicCmpXchg)

Atomic compare exchange

Syntax:

operation ::= `cir.atomic.cmp_xchg` `(`
              $ptr `:` qualified(type($ptr)) `,`
              $expected `:` type($expected) `,`
              $desired `:` type($desired) `,`
              `success` `=`  $succ_order `,`
              `failure` `=`  $fail_order
              `)`
              (`syncscope` `(` $syncscope^ `)`)?
              (`align` `(` $alignment^ `)`)?
              (`weak` $weak^)?
              (`volatile` $is_volatile^)?
              `:` `(` type($old) `,` type($cmp) `)` attr-dict

C/C++ Atomic compare and exchange operation. Implements builtins like __atomic_compare_exchange_n and __atomic_compare_exchange.

Example: %old, %cmp = cir.atomic.cmp_xchg(%ptr : !cir.ptr<!some_record>, %expected : !u64i, %desired : !u64i, success = seq_cst, failure = seq_cst) weak : (!u64i, !cir.bool)

Interfaces: InferTypeOpInterface

Attributes:

Operands:

Results:

cir.atomic.fence (::cir::AtomicFence)

Atomic thread fence

Syntax:

operation ::= `cir.atomic.fence` (`syncscope` `(` $syncscope^ `)`)? $ordering attr-dict

C/C++ Atomic thread fence synchronization primitive. Implements the builtin __atomic_thread_fence which enforces memory ordering constraints across threads within the specified synchronization scope.

This handles all variations including:

• __atomic_thread_fence
• __atomic_signal_fence
• __c11_atomic_thread_fence
• __c11_atomic_signal_fence

Example:

  cir.atomic.fence syncscope(system) seq_cst
  cir.atomic.fence syncscope(single_thread) seq_cst

Attributes:

cir.atomic.fetch (::cir::AtomicFetch)

Atomic fetch with unary and binary operations

Syntax:

operation ::= `cir.atomic.fetch` `(`
              $binop `,`
              $ptr `:` type($ptr) `,`
              $val `:` type($val) `,`
              $mem_order `)`
              (`volatile` $is_volatile^)?
              (`fetch_first` $fetch_first^)?
              `:` type($result) attr-dict

Represents __atomic_<binop>_fetch and __atomic_fetch_<binop> builtins, where binop is on of the binary opcodes : add, sub, and, xor, or, nand, max and min.

ptr is an integer or fp pointer, followed by val, which must be an integer or fp (only supported for add and sub). The operation can also be marked volatile.

If fetch_first is present, the operation works like __atomic_fetch_binop and returns the value that had previously been in *ptr, otherwise it returns the final result of the computation (__atomic_binop_fetch).

Example: %res = cir.atomic.fetch(add, %ptr : !cir.ptr<!s32i>, %val : !s32i, seq_cst) : !s32i

Interfaces: InferTypeOpInterface

Attributes:

Operands:

Results:

cir.atomic.xchg (::cir::AtomicXchg)

Atomic exchange

Syntax:

operation ::= `cir.atomic.xchg` `(`
              $ptr `:` qualified(type($ptr)) `,`
              $val `:` type($val) `,`
              $mem_order `)`
              (`volatile` $is_volatile^)?
              `:` type($result) attr-dict

Atomic exchange operations. Implements C/C++ builtins such as __atomic_exchangeand __atomic_exchange_n.

Example: %res = cir.atomic.xchg(%ptr : !cir.ptr<!some_record>, %val : !u64i, seq_cst) : !u64i

Interfaces: InferTypeOpInterface

Attributes:

Operands:

Results:

cir.await (::cir::AwaitOp)

Wraps C++ co_await implicit logic

Syntax:

operation ::= `cir.await` `(` $kind `,`
              `ready` `:` $ready `,`
              `suspend` `:` $suspend `,`
              `resume` `:` $resume `,`
              `)`
              attr-dict

The under the hood effect of using C++ co_await expr roughly translates to:

// co_await expr;

auto &&x = CommonExpr();
if (!x.await_ready()) {
   ...
   x.await_suspend(...);
   ...
}
x.await_resume();

cir.await represents this logic by using 3 regions:

• ready: covers veto power from x.await_ready()
• suspend: wraps actual x.await_suspend() logic
• resume: handles x.await_resume()

Breaking this up in regions allow individual scrutiny of conditions which might lead to folding some of them out. Lowerings coming out of CIR, e.g. LLVM, should use the suspend region to track more lower level codegen (e.g. intrinsic emission for coro.save/coro.suspend).

There are also 4 flavors of cir.await available:

• init: compiler generated initial suspend via implicit co_await.
• user: also known as normal, representing user written co_await's.
• yield: user written co_yield expressions.
• final: compiler generated final suspend via implicit co_await.

From the C++ snippet we get:

  cir.scope {
    ... // auto &&x = CommonExpr();
    cir.await(user, ready : {
      ... // x.await_ready()
    }, suspend : {
      ... // x.await_suspend()
    }, resume : {
      ... // x.await_resume()
    })
  }

Note that resulution of the common expression is assumed to happen as part of the enclosing await scope.

Traits: NoRegionArguments, RecursivelySpeculatableImplTrait

Interfaces: ConditionallySpeculatable, RegionBranchOpInterface

Attributes:

cir.base_class_addr (::cir::BaseClassAddrOp)

Get the base class address for a class/struct

Syntax:

operation ::= `cir.base_class_addr` `(`
              $derived_addr `:` qualified(type($derived_addr))
              (`nonnull` $assume_not_null^)?
              `)` `[` $offset `]` `->` qualified(type($base_addr)) attr-dict

The cir.base_class_addr operaration gets the address of a particular non-virtual base class given a derived class pointer. The offset in bytes of the base class must be passed in, since it is easier for the front end to calculate that than the MLIR passes. The operation contains a flag for whether or not the operand may be nullptr. That depends on the context and cannot be known by the operation, and that information affects how the operation is lowered.

Example:

struct Base { };
struct Derived : Base { };
Derived d;
Base& b = d;

will generate

%3 = cir.base_class_addr (%1 : !cir.ptr<!rec_Derived> nonnull) [0] -> !cir.ptr<!rec_Base>

Attributes:

Operands:

Results:

cir.base_data_member (::cir::BaseDataMemberOp)

Cast a derived class data member pointer to a base class data member pointer

Syntax:

operation ::= `cir.base_data_member` `(` $src `:` qualified(type($src)) `)`
              `[` $offset `]` `->` qualified(type($result)) attr-dict

The cir.base_data_member operation casts a data member pointer of type T Derived::* to a data member pointer of type T Base::*, where Base is an accessible non-ambiguous non-virtual base class of Derived.

The offset parameter gives the offset in bytes of the Base base class subobject within a Derived object.

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.base_method (::cir::BaseMethodOp)

Cast a derived class pointer-to-member-function to a base class pointer-to-member-function

Syntax:

operation ::= `cir.base_method` `(` $src `:` qualified(type($src)) `)`
              `[` $offset `]` `->` qualified(type($result)) attr-dict

The cir.base_method operation casts a pointer-to-member-function of type Ret (Derived::*)(Args) to a pointer-to-member-function of type Ret (Base::*)(Args), where Base is a non-virtual base class of Derived.

The offset parameter gives the offset in bytes of the Base base class subobject within a Derived object.

Example:

%1 = cir.base_method(%0 : !cir.method<!cir.func<(!s32i)> in !rec_Derived>) [16] -> !cir.method<!cir.func<(!s32i)> in !rec_Base>

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.binop (::cir::BinOp)

Binary operations (arith and logic)

Syntax:

operation ::= `cir.binop` `(` $kind `,` $lhs `,` $rhs  `)`
              (`nsw` $no_signed_wrap^)?
              (`nuw` $no_unsigned_wrap^)?
              (`sat` $saturated^)?
              `:` type($lhs) attr-dict

cir.binop performs the binary operation according to the specified opcode kind: [mul, div, rem, add, sub, and, xor, or].

It requires two input operands and has one result, all types should be the same.

%7 = cir.binop(add, %1, %2) : !s32i
%7 = cir.binop(mul, %1, %2) : !u8i

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType, SameTypeOperands

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.binop.overflow (::cir::BinOpOverflowOp)

Perform binary integral arithmetic with overflow checking

Syntax:

operation ::= `cir.binop.overflow` `(` $kind `,` $lhs `,` $rhs `)` `:` type($lhs) `,`
              `(` type($result) `,` type($overflow) `)`
              attr-dict

cir.binop.overflow performs binary arithmetic operations with overflow checking on integral operands.

The kind argument specifies the kind of arithmetic operation to perform. It can be either add, sub, or mul. The lhs and rhs arguments specify the input operands of the arithmetic operation. The types of lhs and rhs must be the same.

cir.binop.overflow produces two SSA values. result is the result of the arithmetic operation truncated to its specified type. overflow is a boolean value indicating whether overflow happens during the operation.

The exact semantic of this operation is as follows:

• lhs and rhs are promoted to an imaginary integral type that has infinite precision.
• The arithmetic operation is performed on the promoted operands.
• The infinite-precision result is truncated to the type of result. The truncated result is assigned to result.
• If the truncated result is equal to the un-truncated result, overflow is assigned to false. Otherwise, overflow is assigned to true.

Traits: AlwaysSpeculatableImplTrait, SameTypeOperands

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.bit.clrsb (::cir::BitClrsbOp)

Get the number of leading redundant sign bits in the input

Syntax:

operation ::= `cir.bit.clrsb` `(` $input `:` type($input) `)` `:` type($result) attr-dict

Compute the number of leading redundant sign bits in the input integer.

The input integer must be a signed integer. The most significant bit of the input integer is the sign bit. The cir.bit.clrsb operation returns the number of redundant sign bits in the input, that is, the number of bits following the most significant bit that are identical to it.

The bit width of the input integer must be either 32 or 64.

Examples:

!s32i = !cir.int<s, 32>

// %0 = 0xDEADBEEF, 0b1101_1110_1010_1101_1011_1110_1110_1111
%0 = cir.const #cir.int<3735928559> : !s32i
// %1 will be 1 because there is 1 bit following the most significant bit
// that is identical to it.
%1 = cir.bit.clrsb(%0 : !s32i) : !s32i

// %2 = 1, 0b0000_0000_0000_0000_0000_0000_0000_0001
%2 = cir.const #cir.int<1> : !s32i
// %3 will be 30
%3 = cir.bit.clrsb(%2 : !s32i) : !s32i

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.bit.clz (::cir::BitClzOp)

Get the number of leading 0-bits in the input

Syntax:

operation ::= `cir.bit.clz` `(` $input `:` type($input) `)` (`zero_poison` $is_zero_poison^)?
              `:` type($result) attr-dict

Compute the number of leading 0-bits in the input.

The input integer must be an unsigned integer. The cir.bit.clz operation returns the number of consecutive 0-bits at the most significant bit position in the input.

Zero_poison attribute means this operation invokes undefined behavior if the input value is 0.

Example:

!u32i = !cir.int<u, 32>

// %0 = 0b0000_0000_0000_0000_0000_0000_0000_1000
%0 = cir.const #cir.int<8> : !u32i
// %1 will be 28
%1 = cir.bit.clz(%0 : !u32i) zero_poison : !u32i

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.bit.ctz (::cir::BitCtzOp)

Get the number of trailing 0-bits in the input

Syntax:

operation ::= `cir.bit.ctz` `(` $input `:` type($input) `)` (`zero_poison` $is_zero_poison^)?
              `:` type($result) attr-dict

Compute the number of trailing 0-bits in the input.

The input integer must be an unsigned integer. The cir.bit.ctz operation returns the number of consecutive 0-bits at the least significant bit position in the input.

Zero_poison attribute means this operation invokes undefined behavior if the input value is 0.

Example:

!s32i = !cir.int<s, 32>
!u32i = !cir.int<u, 32>

// %0 = 0b1000
%0 = cir.const #cir.int<8> : !u32i
// %1 will be 3
%1 = cir.bit.ctz(%0 : !u32i) : !u32i

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.bit.ffs (::cir::BitFfsOp)

Get the position of the least significant 1-bit of input

Syntax:

operation ::= `cir.bit.ffs` `(` $input `:` type($input) `)` `:` type($result) attr-dict

Compute the position of the least significant 1-bit of the input.

The input integer must be a signed integer. The cir.bit.ffs operation returns one plus the index of the least significant 1-bit of the input signed integer. As a special case, if the input integer is 0, cir.bit.ffs returns 0.

Example:

!s32i = !cir.int<s, 32>

// %0 = 0x0010_1000
%0 = cir.const #cir.int<40> : !s32i
// #1 will be 4 since the 4th least significant bit is 1.
%1 = cir.bit.ffs(%0 : !s32i) : !s32i

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.bit.parity (::cir::BitParityOp)

Get the parity of input

Syntax:

operation ::= `cir.bit.parity` `(` $input `:` type($input) `)` `:` type($result) attr-dict

Compute the parity of the input. The parity of an integer is the number of 1-bits in it modulo 2.

The input must be an unsigned integer.

Example:

!s32i = !cir.int<s, 32>
!u32i = !cir.int<u, 32>

// %0 = 0x0110_1000
%0 = cir.const #cir.int<104> : !u32i
// %1 will be 1 since there are 3 1-bits in %0
%1 = cir.bit.parity(%0 : !u32i) : !u32i

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.bit.popcount (::cir::BitPopcountOp)

Get the number of 1-bits in input

Syntax:

operation ::= `cir.bit.popcount` `(` $input `:` type($input) `)` `:` type($result) attr-dict

Compute the number of 1-bits in the input.

The input must be an unsigned integer.

Example:

!u32i = !cir.int<u, 32>

// %0 = 0x0110_1000
%0 = cir.const #cir.int<104> : !u32i
// %1 will be 3 since there are 3 1-bits in %0
%1 = cir.bit.popcount(%0 : !u32i) : !u32i

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.bit_reverse (::cir::BitReverseOp)

Reverse the bit pattern of the operand integer

Syntax:

operation ::= `cir.bit_reverse` $src `:` type($result) attr-dict

The cir.bit_reverse operation reverses the bit pattern of the operand integer. Its only argument must be of unsigned integer types of width 8, 16, 32, or 64.

This operation covers the C/C++ builtin function __builtin_bitreverse.

Example:

%1 = cir.bit_reverse %0 : !u32i

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.brcond (::cir::BrCondOp)

Conditional branch

Syntax:

operation ::= `cir.brcond` $cond
              $destTrue (`(` $destOperandsTrue^ `:` type($destOperandsTrue) `)`)?
              `,`
              $destFalse (`(` $destOperandsFalse^ `:` type($destOperandsFalse) `)`)?
              attr-dict

The cir.brcond %cond, ^bb0, ^bb1 branches to ‘bb0' block in case %cond (which must be a !cir.bool type) evaluates to true, otherwise it branches to ‘bb1'.

Example:

  ...
    cir.brcond %a, ^bb3, ^bb4
  ^bb3:
    cir.return
  ^bb4:
    cir.yield

Traits: AlwaysSpeculatableImplTrait, AttrSizedOperandSegments, Terminator

Interfaces: BranchOpInterface, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Successors:

cir.br (::cir::BrOp)

Unconditional branch

Syntax:

operation ::= `cir.br` $dest (`(` $destOperands^ `:` type($destOperands) `)`)? attr-dict

The cir.br branches unconditionally to a block. Used to represent C/C++ goto's and general block branching.

Note that for source level goto's crossing scope boundaries, those are usually represented with the "symbolic" cir.goto operation.

Example:

  ...
    cir.br ^bb3
  ^bb3:
    cir.return

Traits: AlwaysSpeculatableImplTrait, Terminator

Interfaces: BranchOpInterface, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Successors:

cir.break (::cir::BreakOp)

C/C++ break statement equivalent

Syntax:

operation ::= `cir.break` attr-dict

The cir.break operation is used to cease the control flow to the parent operation, exiting its region's control flow. It is only allowed if it is within a breakable operation (loops and switch).

Traits: Terminator

cir.bswap (::cir::ByteswapOp)

Reverse the bytes that constitute the operand integer

Syntax:

operation ::= `cir.bswap` `(` $input `:` type($input) `)` `:` type($result) attr-dict

The cir.bswap operation takes an integer as operand, and returns it with the order of bytes that constitute the operand reversed.

The operand integer must be an unsigned integer. Its widths must be either 16, 32, or 64.

Example:

!u32i = !cir.int<u, 32>

// %0 = 0x12345678
%0 = cir.const #cir.int<305419896> : !u32i

// %1 should be 0x78563412
%1 = cir.bswap(%0 : !u32i) : !u32i

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.asm (::cir::InlineAsmOp)

The cir.asm operation represents C/C++ asm inline.

CIR constraints strings follow barelly the same rules that are established for the C level assembler constraints with several differences caused by clang::AsmStmt processing.

Thus, numbers that appears in the constraint string may also refer to:

• the output variable index referenced by the input operands.
• the index of early-clobber operand

Operand attributes is a storage, where each element corresponds to the operand with the same index. The first index relates to the operation result (if any). Note, the operands themselves are stored as VariadicOfVariadic in the next order: output, input and then in/out operands.

Note, when several output operands are present, the result type may be represented as an anon record type.

Example:

__asm__("foo" : : : );
__asm__("bar $42 %[val]" : [val] "=r" (x), "+&r"(x));
__asm__("baz $42 %[val]" : [val] "=r" (x), "+&r"(x) : "[val]"(y));

!rec_22anon2E022 = !cir.record<struct "anon.0" {!cir.int<s, 32>, !cir.int<s, 32>}>
!rec_22anon2E122 = !cir.record<struct "anon.1" {!cir.int<s, 32>, !cir.int<s, 32>}>
...
%0 = cir.alloca !s32i, !cir.ptr<!s32i>, ["x", init]
%1 = cir.alloca !s32i, !cir.ptr<!s32i>, ["y", init]
...
%2 = cir.load %0 : !cir.ptr<!s32i>, !s32i
%3 = cir.load %1 : !cir.ptr<!s32i>, !s32i

cir.asm(x86_att,
  out = [],
  in = [],
  in_out = [],
  {"foo" "~{dirflag},~{fpsr},~{flags}"}) side_effects

cir.asm(x86_att,
  out = [],
  in = [],
  in_out = [%2 : !s32i],
  {"bar $$42 $0" "=r,=&r,1,~{dirflag},~{fpsr},~{flags}"}) -> !rec_22anon2E022

cir.asm(x86_att,
  out = [],
  in = [%3 : !s32i],
  in_out = [%2 : !s32i],
  {"baz $$42 $0" "=r,=&r,0,1,~{dirflag},~{fpsr},~{flags}"}) -> !rec_22anon2E122

Traits: RecursiveMemoryEffects

Attributes:

Operands:

Results:

cir.call (::cir::CallOp)

Call operation

Direct and indirect calls.

For direct calls, the call operation represents a direct call to a function that is within the same symbol scope as the call. The operands and result types of the call must match the specified function type. The callee is encoded as a aymbol reference attribute named "callee".

For indirect calls, the first mlir::Operation operand is the call target.

Given the way indirect calls are encoded, avoid using mlir::Operation methods to walk the operands for this operation, instead use the methods provided by CIRCallOpInterface.

If the cir.call has the exception keyword, the call can throw. In this case, cleanups can be added in the cleanup region.

Example:

// Direct call
%2 = cir.call @my_add(%0, %1) : (f32, f32) -> f32
 ...
// Indirect call
%20 = cir.call %18(%17)
 ...
// Call that might throw
cir.call exception @my_div() -> () cleanup {
  // call dtor...
}

Traits: NoRegionArguments

Interfaces: CIRCallOpInterface, CallOpInterface, SymbolUserOpInterface

Attributes:

Operands:

Results:

cir.case (::cir::CaseOp)

Case operation

Syntax:

operation ::= `cir.case` `(` $kind `,` $value `)` $caseRegion attr-dict

The cir.case operation represents a case within a C/C++ switch. The cir.case operation must be in a cir.switch operation directly or indirectly.

The cir.case have 4 kinds:

• equal, <constant>: equality of the second case operand against the condition.
• anyof, [constant-list]: equals to any of the values in a subsequent following list.
• range, [lower-bound, upper-bound]: the condition is within the closed interval.
• default: any other value.

Each case region must be explicitly terminated.

Traits: AutomaticAllocationScope, RecursivelySpeculatableImplTrait

Interfaces: ConditionallySpeculatable, RegionBranchOpInterface

Attributes:

cir.cast (::cir::CastOp)

Conversion between values of different types

Syntax:

operation ::= `cir.cast` `(` $kind `,` $src `:` type($src) `)`
              `,` type($result) attr-dict

Apply C/C++ usual conversions rules between values. Currently supported kinds:

• array_to_ptrdecay
• bitcast
• integral
• int_to_bool
• int_to_float
• floating
• float_to_int
• float_to_bool
• ptr_to_int
• ptr_to_bool
• bool_to_int
• bool_to_float
• address_space
• float_to_complex
• int_to_complex
• float_complex_to_real
• int_complex_to_real
• float_complex_to_bool
• int_complex_to_bool
• float_complex
• float_complex_to_int_complex
• int_complex
• int_complex_to_float_complex

This is effectively a subset of the rules from llvm-project/clang/include/clang/AST/OperationKinds.def; but note that some of the conversions aren't implemented in terms of cir.cast, lvalue-to-rvalue for instance is modeled as a regular cir.load.

%4 = cir.cast (int_to_bool, %3 : i32), !cir.bool
...
%x = cir.cast(array_to_ptrdecay, %0 : !cir.ptr<!cir.array<i32 x 10>>), !cir.ptr<i32>

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface), PromotableOpInterface

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.catch_param (::cir::CatchParamOp)

Represents catch clause formal parameter

Syntax:

operation ::= `cir.catch_param` ($kind^)?
              ($exception_ptr^)?
              (`->` qualified(type($param))^)?
              attr-dict

The cir.catch_param can operate in two modes: within catch regions of cir.try or anywhere else with the begin or end markers. The begin version requires an exception pointer of cir.ptr<!void>.

Example:

// TBD

Attributes:

Operands:

Results:

cir.ceil (::cir::CeilOp)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.ceil` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.clear_cache (::cir::ClearCacheOp)

Clear cache operation

Syntax:

operation ::= `cir.clear_cache` $begin `:` qualified(type($begin)) `,`
              $end `,`
              attr-dict

CIR representation for __builtin___clear_cache.

Operands:

cir.cmp (::cir::CmpOp)

Compare values two values and produce a boolean result

Syntax:

operation ::= `cir.cmp` `(` $kind `,` $lhs `,` $rhs  `)` `:` type($lhs) `,` type($result) attr-dict

cir.cmp compares two input operands of the same type and produces a cir.bool result. The kinds of comparison available are: [lt,gt,ge,eq,ne]

%7 = cir.cmp(gt, %1, %2) : i32, !cir.bool

Traits: AlwaysSpeculatableImplTrait, SameTypeOperands

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.cmp3way (::cir::CmpThreeWayOp)

Compare two values with C++ three-way comparison semantics

Syntax:

operation ::= `cir.cmp3way` `(` $lhs `:` type($lhs) `,` $rhs `,` qualified($info) `)`
              `:` type($result) attr-dict

The cir.cmp3way operation models the <=> operator in C++20. It takes two operands with the same type and produces a result indicating the ordering between the two input operands.

The result of the operation is a signed integer that indicates the ordering between the two input operands.

There are two kinds of ordering: strong ordering and partial ordering. Comparing different types of values yields different kinds of orderings. The info parameter gives the ordering kind and other necessary information about the comparison.

Example:

!s32i = !cir.int<s, 32>

#cmp3way_strong = #cmp3way_info<strong, lt = -1, eq = 0, gt = 1>
#cmp3way_partial = #cmp3way_info<strong, lt = -1, eq = 0, gt = 1, unordered = 2>

%0 = cir.const #cir.int<0> : !s32i
%1 = cir.const #cir.int<1> : !s32i
%2 = cir.cmp3way(%0 : !s32i, %1, #cmp3way_strong) : !s8i

%3 = cir.const #cir.fp<0.0> : !cir.float
%4 = cir.const #cir.fp<1.0> : !cir.float
%5 = cir.cmp3way(%3 : !cir.float, %4, #cmp3way_partial) : !s8i

Traits: AlwaysSpeculatableImplTrait, SameTypeOperands

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.complex.binop (::cir::ComplexBinOp)

Binary operations on operands of complex type

Syntax:

operation ::= `cir.complex.binop` $kind $lhs `,` $rhs `range` `(` $range `)` (`promoted` $promoted^)?
              `:` qualified(type($lhs)) attr-dict

The cir.complex.binop operation represents a binary operation on operands of C complex type (e.g. float _Complex). The operation can only represent binary multiplication or division on complex numbers; other binary operations, such as addition and subtraction, are represented by the cir.binop operation.

The operation requires two input operands and has one result. The types of all the operands and the result should be of the same !cir.complex type.

The operation also takes a range attribute that specifies the complex range of the binary operation.

Examples:

%2 = cir.complex.binop add %0, %1 : !cir.complex<!cir.float>
%2 = cir.complex.binop mul %0, %1 : !cir.complex<!cir.float>

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType, SameTypeOperands

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.complex.create (::cir::ComplexCreateOp)

Create a complex value from its real and imaginary parts

Syntax:

operation ::= `cir.complex.create` $real `,` $imag
              `:` qualified(type($real)) `->` qualified(type($result)) attr-dict

cir.complex.create operation takes two operands that represent the real and imaginary part of a complex number, and yields the complex number.

Example:

%0 = cir.const #cir.fp<1.000000e+00> : !cir.double
%1 = cir.const #cir.fp<2.000000e+00> : !cir.double
%2 = cir.complex.create %0, %1 : !cir.complex<!cir.double>

Traits: AlwaysSpeculatableImplTrait, SameTypeOperands

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.complex.imag (::cir::ComplexImagOp)

Extract the imaginary part of a complex value

Syntax:

operation ::= `cir.complex.imag` $operand `:` qualified(type($operand)) `->` qualified(type($result))
              attr-dict

cir.complex.imag operation takes an operand of !cir.complex type and yields the imaginary part of it.

Example:

%1 = cir.complex.imag %0 : !cir.complex<!cir.float> -> !cir.float

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.complex.imag_ptr (::cir::ComplexImagPtrOp)

Derive a pointer to the imaginary part of a complex value

Syntax:

operation ::= `cir.complex.imag_ptr` $operand `:`
              qualified(type($operand)) `->` qualified(type($result)) attr-dict

cir.complex.imag_ptr operation takes a pointer operand that points to a complex value of type !cir.complex and yields a pointer to the imaginary part of the operand.

Example:

%1 = cir.complex.imag_ptr %0 : !cir.ptr<!cir.complex<!cir.double>> -> !cir.ptr<!cir.double>

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.complex.real (::cir::ComplexRealOp)

Extract the real part of a complex value

Syntax:

operation ::= `cir.complex.real` $operand `:` qualified(type($operand)) `->` qualified(type($result))
              attr-dict

cir.complex.real operation takes an operand of !cir.complex type and yields the real part of it.

Example:

%1 = cir.complex.real %0 : !cir.complex<!cir.float> -> !cir.float

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.complex.real_ptr (::cir::ComplexRealPtrOp)

Derive a pointer to the real part of a complex value

Syntax:

operation ::= `cir.complex.real_ptr` $operand `:`
              qualified(type($operand)) `->` qualified(type($result)) attr-dict

cir.complex.real_ptr operation takes a pointer operand that points to a complex value of type !cir.complex and yields a pointer to the real part of the operand.

Example:

%1 = cir.complex.real_ptr %0 : !cir.ptr<!cir.complex<!cir.double>> -> !cir.ptr<!cir.double>

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.condition (::cir::ConditionOp)

Loop continuation condition.

Syntax:

operation ::= `cir.condition` `(` $condition `)` attr-dict

The cir.condition terminates conditional regions. It takes a single cir.bool operand and, depending on its value, may branch to different regions:

• When in the cond region of a cir.loop, it continues the loop if true, or exits it if false.
• When in the ready region of a cir.await, it branches to the resume region when true, and to the suspend region when false.

Example:

cir.loop for(cond : {
  cir.condition(%arg0) // Branches to `step` region or exits.
}, step : {
  [...]
}) {
  [...]
}

cir.await(user, ready : {
  cir.condition(%arg0) // Branches to `resume` or `suspend` region.
}, suspend : {
  [...]
}, resume : {
  [...]
},)

Traits: Terminator

Interfaces: RegionBranchTerminatorOpInterface

Operands:

cir.const (::cir::ConstantOp)

Defines a CIR constant

Syntax:

operation ::= `cir.const` attr-dict $value

The cir.const operation turns a literal into an SSA value. The data is attached to the operation as an attribute.

  %0 = cir.const 42 : i32
  %1 = cir.const 4.2 : f32
  %2 = cir.const nullptr : !cir.ptr<i32>

Traits: AlwaysSpeculatableImplTrait, ConstantLike

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Results:

cir.continue (::cir::ContinueOp)

C/C++ continue statement equivalent

Syntax:

operation ::= `cir.continue` attr-dict

The cir.continue operation is used to continue execution to the next iteration of a loop. It is only allowed within cir.loop regions.

Traits: Terminator

cir.copy (::cir::CopyOp)

Copies contents from a CIR pointer to another

Syntax:

operation ::= `cir.copy` $src `to` $dst (`volatile` $is_volatile^)?
              attr-dict `:` qualified(type($dst))
              (`tbaa` `(` $tbaa^ `)`)?

Given two CIR pointers, src and dst, cir.copy will copy the memory pointed by src to the memory pointed by dst.

The amount of bytes copied is inferred from the pointee type. Naturally, the pointee type of both src and dst must match and must implement the DataLayoutTypeInterface.

Examples:

  // Copying contents from one record to another:
  cir.copy %0 to %1 : !cir.ptr<!record_ty>

Traits: SameTypeOperands

Interfaces: PromotableMemOpInterface

Attributes:

Operands:

cir.copysign (::cir::CopysignOp)

Libc builtin equivalent ignoring floating-point exceptions and errno.

Syntax:

operation ::= `cir.copysign` $lhs `,` $rhs `:` qualified(type($lhs)) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.cos (::cir::CosOp)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.cos` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.delete.array (::cir::DeleteArrayOp)

Delete address representing an array

Syntax:

operation ::= `cir.delete.array` $address `:` type($address) attr-dict

cir.delete.array operation deletes an array. For example, delete[] ptr; will be translated to cir.delete.array %ptr.

Operands:

cir.derived_class_addr (::cir::DerivedClassAddrOp)

Get the derived class address for a class/struct

Syntax:

operation ::= `cir.derived_class_addr` `(`
              $base_addr `:` qualified(type($base_addr))
              (`nonnull` $assume_not_null^)?
              `)` `[` $offset `]` `->` qualified(type($derived_addr)) attr-dict

The cir.derived_class_addr operaration gets the address of a particular derived class given a non-virtual base class pointer. The offset in bytes of the base class must be passed in, similar to cir.base_class_addr, but going into the other direction (In the itanium ABI this means lowering to a negative offset).

The operation contains a flag for whether or not the operand may be nullptr. That depends on the context and cannot be known by the operation, and that information affects how the operation is lowered.

Example:

class A { int a; };
class B { int b;
public:
    A *getAsA();
};
class X : public A, public B { int x; };

A *B::getAsA() {
  return static_cast<X*>(this);

leads to

  %2 = cir.load %0 : !cir.ptr<!cir.ptr<!rec_B>>, !cir.ptr<!rec_B>
  %3 = cir.derived_class_addr(%2 : !cir.ptr<!rec_B> nonnull) [4] -> !cir.ptr<!rec_X>
  %4 = cir.base_class_addr(%3 : !cir.ptr<!rec_X>) [0] -> !cir.ptr<!rec_A>
  cir.return %4

Attributes:

Operands:

Results:

cir.derived_data_member (::cir::DerivedDataMemberOp)

Cast a base class data member pointer to a derived class data member pointer

Syntax:

operation ::= `cir.derived_data_member` `(` $src `:` qualified(type($src)) `)`
              `[` $offset `]` `->` qualified(type($result)) attr-dict

The cir.derived_data_member operation casts a data member pointer of type T Base::* to a data member pointer of type T Derived::*, where Base is an accessible non-ambiguous non-virtual base class of Derived.

The offset parameter gives the offset in bytes of the Base base class subobject within a Derived object.

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.derived_method (::cir::DerivedMethodOp)

Cast a base class pointer-to-member-function to a derived class pointer-to-member-function

Syntax:

operation ::= `cir.derived_method` `(` $src `:` qualified(type($src)) `)`
              `[` $offset `]` `->` qualified(type($result)) attr-dict

The cir.derived_method operation casts a pointer-to-member-function of type Ret (Base::*)(Args) to a pointer-to-member-function of type Ret (Derived::*)(Args), where Base is a non-virtual base class of Derived.

The offset parameter gives the offset in bytes of the Base base class subobject within a Derived object.

Example:

%1 = cir.derived_method(%0 : !cir.method<!cir.func<(!s32i)> in !rec_Base>) [16] -> !cir.method<!cir.func<(!s32i)> in !rec_Derived>

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.do (::cir::DoWhileOp)

C/C++ do-while loop

Syntax:

operation ::= `cir.do` $body `while` $cond attr-dict

Represents a C/C++ do-while loop. Identical to cir.while but the condition is evaluated after the body.

Example:

cir.do {
  cir.break
^bb2:
  cir.yield
} while {
  cir.condition %cond : cir.bool
}

Traits: NoRegionArguments

Interfaces: LoopLikeOpInterface, LoopOpInterface, RegionBranchOpInterface

cir.dyn_cast (::cir::DynamicCastOp)

Perform dynamic cast on record pointers

Syntax:

operation ::= `cir.dyn_cast` `(`
              $kind `,` $src `:` type($src)
              (`,` qualified($info)^)?
              (`relative_layout` $relative_layout^)?
              `)`
              `->` qualified(type($result)) attr-dict

The cir.dyn_cast operation models part of the semantics of the dynamic_cast operator in C++. It can be used to perform 3 kinds of casts on record pointers:

• Down-cast, which casts a base class pointer to a derived class pointer;
• Side-cast, which casts a class pointer to a sibling class pointer;
• Cast-to-complete, which casts a class pointer to a void pointer.

The input of the operation must be a record pointer. The result of the operation is either a record pointer or a void pointer.

The parameter kind specifies the semantics of this operation. If its value is ptr, then the operation models dynamic casts on pointers. Otherwise, if its value is ref, the operation models dynamic casts on references. Specifically:

• When the input pointer is a null pointer value:
  • If kind is ref, the operation will invoke undefined behavior. A sanitizer check will be emitted if sanitizer is on.
  • Otherwise, the operation will return a null pointer value as its result.
• When the runtime type check fails:
  • If kind is ref, the operation will throw a bad_cast exception.
  • Otherwise, the operation will return a null pointer value as its result.

The info argument gives detailed information about the requested dynamic cast operation. It is an optional #cir.dyn_cast_info attribute that is only present when the operation models a down-cast or a side-cast.

The relative_layout argument specifies whether the Itanium C++ ABI vtable uses relative layout. It is only meaningful when the operation models a cast-to-complete operation.

Attributes:

Operands:

Results:

cir.eh.inflight_exception (::cir::EhInflightOp)

Materialize the catch clause formal parameter

Syntax:

operation ::= `cir.eh.inflight_exception` (`cleanup` $cleanup^)?
              ($sym_type_list^)?
              attr-dict

cir.eh.inflight_exception returns two values:

• exception_ptr: The exception pointer for the inflight exception
• type_id: pointer to the exception object This operation is expected to be the first one basic blocks on the exception path out of cir.try_call operations.

The cleanup attribute indicates that clean up code might run before the values produced by this operation are used to gather exception information. This helps CIR to pass down more accurate information for LLVM lowering to landingpads.

Interfaces: InferTypeOpInterface

Attributes:

Results:

cir.eh.typeid (::cir::EhTypeIdOp)

Compute exception type id from it's global type symbol

Syntax:

operation ::= `cir.eh.typeid` $type_sym attr-dict

Returns the exception type id for a given global symbol representing a type.

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface), SymbolUserOpInterface

Effects: MemoryEffects::Effect{}

Attributes:

Results:

cir.exp2 (::cir::Exp2Op)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.exp2` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.exp (::cir::ExpOp)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.exp` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.expect (::cir::ExpectOp)

Compute whether expression is likely to evaluate to a specified value

Syntax:

operation ::= `cir.expect` `(` $val`,` $expected (`,` $prob^)? `)` `:` type($val) attr-dict

Provides __builtin_expect functionality in Clang IR.

If $prob is not specified, then behaviour is same as __builtin_expect. If specified, then behaviour is same as __builtin_expect_with_probability, where probability = $prob.

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.extract_member (::cir::ExtractMemberOp)

Extract the value of a member of a record value

Syntax:

operation ::= `cir.extract_member` $record `[` $index_attr `]` attr-dict
              `:` qualified(type($record)) `->` qualified(type($result))

The cir.extract_member operation extracts the value of a particular member from the input record. Unlike cir.get_member which derives pointers, this operation operates on values. It takes a value of record type, and extract the value of the specified record member from the input record value.

Currently cir.extract_member does not work on unions.

Example:

// Suppose we have a record with multiple members.
!s32i = !cir.int<s, 32>
!s8i = !cir.int<s, 32>
!record_ty = !cir.record<"struct.Bar" {!s32i, !s8i}>

// And suppose we have a value of the record type.
%0 = cir.const #cir.const_record<{#cir.int<1> : !s32i, #cir.int<2> : !s8i}> : !record_ty

// Extract the value of the second member of the record.
%1 = cir.extract_member %0[1] : !record_ty -> !s8i

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.fabs (::cir::FAbsOp)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.fabs` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.fmaxnum (::cir::FMaxNumOp)

Libc builtin equivalent ignoring floating-point exceptions and errno.

Syntax:

operation ::= `cir.fmaxnum` $lhs `,` $rhs `:` qualified(type($lhs)) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.fmaximum (::cir::FMaximumOp)

Libc builtin equivalent ignoring floating-point exceptions and errno.

Syntax:

operation ::= `cir.fmaximum` $lhs `,` $rhs `:` qualified(type($lhs)) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.fminnum (::cir::FMinNumOp)

Libc builtin equivalent ignoring floating-point exceptions and errno.

Syntax:

operation ::= `cir.fminnum` $lhs `,` $rhs `:` qualified(type($lhs)) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.fminimum (::cir::FMinimumOp)

Libc builtin equivalent ignoring floating-point exceptions and errno.

Syntax:

operation ::= `cir.fminimum` $lhs `,` $rhs `:` qualified(type($lhs)) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.fmod (::cir::FModOp)

Libc builtin equivalent ignoring floating-point exceptions and errno.

Syntax:

operation ::= `cir.fmod` $lhs `,` $rhs `:` qualified(type($lhs)) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.floor (::cir::FloorOp)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.floor` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.for (::cir::ForOp)

C/C++ for loop counterpart

Syntax:

operation ::= `cir.for` `:` `cond` $cond
              `body` $body
              `step` $step
              attr-dict

Represents a C/C++ for loop. It consists of three regions:

• cond: single block region with the loop's condition. Should be terminated with a cir.condition operation.
• body: contains the loop body and an arbitrary number of blocks.
• step: single block region with the loop's step.

Example:

cir.for cond {
  cir.condition(%val)
} body {
  cir.break
^bb2:
  cir.yield
} step {
  cir.yield
}

Traits: NoRegionArguments

Interfaces: LoopLikeOpInterface, LoopOpInterface, RegionBranchOpInterface

cir.frame_address (::cir::FrameAddrOp)

The frame address of the current function, or of one of its callers

Syntax:

operation ::= `cir.frame_address` `(` $level `)` attr-dict

Represents call to builtin function ` __builtin_frame_address` in CIR. This builtin function returns the frame address of the current function, or of one of its callers. The frame is the area on the stack that holds local variables and saved registers. The frame address is normally the address of the first word pushed on to the stack by the function. However, the exact definition depends upon the processor and the calling convention. If the processor has a dedicated frame pointer register, and the function has a frame, then __builtin_frame_address returns the value of the frame pointer register.

The level argument is number of frames to scan up the call stack. For instance, value of 0 yields the frame address of the current function, value of 1 yields the frame address of the caller of the current function, and so forth.

Examples:

%p = frame_address(%level) -> !cir.ptr<!void>

Interfaces: InferTypeOpInterface

Operands:

Results:

cir.free.exception (::cir::FreeExceptionOp)

Frees an exception according to Itanium ABI

Syntax:

operation ::= `cir.free.exception` $ptr attr-dict

Implements a slightly higher level version of: void __cxa_free_exception(void *thrown_exception);

Example:

%0 = cir.alloc.exception 16 -> !cir.ptr<!some_record>
%1 = cir.get_global @d2 : !cir.ptr<!some_record>
cir.try synthetic cleanup {
  cir.call exception @_ZN7test2_DC1ERKS_(%0, %1) : (!cir.ptr<!some_record>, !cir.ptr<!some_record>) -> () cleanup {
    %2 = cir.cast(bitcast, %0 : !cir.ptr<!some_record>), !cir.ptr<!void>
    cir.free.exception %2
    cir.yield
  }
  ...
}

Operands:

cir.func (::cir::FuncOp)

Declare or define a function

Similar to mlir::FuncOp built-in:

Operations within the function cannot implicitly capture values defined outside of the function, i.e. Functions are IsolatedFromAbove. All external references must use function arguments or attributes that establish a symbolic connection (e.g. symbols referenced by name via a string attribute like SymbolRefAttr). An external function declaration (used when referring to a function declared in some other module) has no body. While the MLIR textual form provides a nice inline syntax for function arguments, they are internally represented as "block arguments" to the first block in the region.

Only dialect attribute names may be specified in the attribute dictionaries for function arguments, results, or the function itself.

The function linkage information is specified by linkage, as defined by GlobalLinkageKind attribute.

The calling_conv attribute specifies the calling convention of the function. The default calling convention is CallingConv::C.

A compiler builtin function must be marked as builtin for further processing when lowering from CIR.

The coroutine keyword is used to mark coroutine function, which requires at least one cir.await instruction to be used in its body.

The lambda translates to a C++ operator() that implements a lambda, this allow callsites to make certain assumptions about the real function nature when writing analysis. The verifier should, but do act on this keyword yet.

The no_proto keyword is used to identify functions that were declared without a prototype and, consequently, may contain calls with invalid arguments and undefined behavior.

The extra_attrs, which is an aggregate of function-specific attributes is required and mandatory to describle additional attributes that are not listed above. Though mandatory, the prining of the attribute can be omitted if it is empty.

The global_ctor indicates whether a function should execute before main() function, as specified by __attribute__((constructor)). A execution priority can also be specified global_ctor(<prio>). Similarly, for global destructors both global_dtor and global_dtor(<prio>) are available.

Example:

// External function definitions.
cir.func @abort()

// A function with internal linkage.
cir.func internal @count(%x: i64) -> (i64)
  return %x : i64
}

// Linkage information
cir.func linkonce_odr @some_method(...)

// Calling convention information
cir.func @another_func(...) cc(spir_kernel) extra(#fn_attr)

// Builtin function
cir.func builtin @__builtin_coro_end(!cir.ptr<i8>, !cir.bool) -> !cir.bool

// Coroutine
cir.func coroutine @_Z10silly_taskv() -> !CoroTask {
  ...
  cir.await(...)
  ...
}

Traits: AutomaticAllocationScope, IsolatedFromAbove

Interfaces: CIRGlobalValueInterface, CallableOpInterface, FunctionOpInterface, Symbol

Attributes:

cir.get_bitfield (::cir::GetBitfieldOp)

Get a bitfield

Syntax:

operation ::= `cir.get_bitfield` `(`$bitfield_info `,` $addr attr-dict `:`
              qualified(type($addr)) `)` `->` type($result)

The cir.get_bitfield operation provides a load-like access to a bit field of a record.

It expects a name if a bit field, a pointer to a storage in the base record, a type of the storage, a name of the bitfield, a size the bit field, an offset of the bit field and a sign.

A unit attribute volatile can be used to indicate a volatile load of the bitfield.

Example: Suppose we have a struct with multiple bitfields stored in different storages. The cir.get_bitfield operation gets the value of the bitfield

typedef struct {
  int a : 4;
  int b : 27;
  int c : 17;
  int d : 2;
  int e : 15;
} S;

int load_bitfield(S& s) {
  return s.d;
}

// 'd' is in the storage with the index 1
!record_type = !cir.record<struct "S" {!cir.int<u, 32>, !cir.int<u, 32>, !cir.int<u, 16>} #cir.record.decl.ast>
#bfi_d = #cir.bitfield_info<name = "d", storage_type = !u32i, size = 2, offset = 17, is_signed = true>

%2 = cir.load %0 : !cir.ptr<!cir.ptr<!record_type>>, !cir.ptr<!record_type>
%3 = cir.get_member %2[1] {name = "d"} : !cir.ptr<!record_type> -> !cir.ptr<!u32i>
%4 = cir.get_bitfield(#bfi_d, %3 : !cir.ptr<!u32i>) -> !s32i

Attributes:

Operands:

Results:

cir.get_global (::cir::GetGlobalOp)

Get the address of a global variable

Syntax:

operation ::= `cir.get_global` (`thread_local` $tls^)?
              $name `:` qualified(type($addr)) attr-dict

The cir.get_global operation retrieves the address pointing to a named global variable. If the global variable is marked constant, writing to the resulting address (such as through a cir.store operation) is undefined. Resulting type must always be a !cir.ptr<...> type with the same address space as the global variable.

Addresses of thread local globals can only be retrieved if this operation is marked thread_local, which indicates the address isn't constant.

Example:

%x = cir.get_global @foo : !cir.ptr<i32>
...
%y = cir.get_global thread_local @batata : !cir.ptr<i32>
...
cir.global external addrspace(offload_global) @gv = #cir.int<0> : !s32i
%z = cir.get_global @gv : !cir.ptr<!s32i, addrspace(offload_global)>

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface), SymbolUserOpInterface

Effects: MemoryEffects::Effect{}

Attributes:

Results:

cir.get_member (::cir::GetMemberOp)

Get the address of a member of a record

Syntax:

operation ::= `cir.get_member` $addr `[` $index_attr `]` attr-dict
              `:` qualified(type($addr)) `->` qualified(type($result))

The cir.get_member operation gets the address of a particular named member from the input record.

It expects a pointer to the base record as well as the name of the member and its field index.

Example:

// Suppose we have a record with multiple members.
!s32i = !cir.int<s, 32>
!s8i = !cir.int<s, 32>
!record_ty = !cir.record<"struct.Bar" {!s32i, !s8i}>

// Get the address of the member at index 1.
%1 = cir.get_member %0[1] {name = "i"} : (!cir.ptr<!record_ty>) -> !cir.ptr<!s8i>

Attributes:

Operands:

Results:

cir.get_method (::cir::GetMethodOp)

Resolve a method to a function pointer as callee

Syntax:

operation ::= `cir.get_method` $method `,` $object
              `:` `(` qualified(type($method)) `,` qualified(type($object)) `)`
              `->` `(` qualified(type($callee)) `,` qualified(type($adjusted_this)) `)`
              attr-dict

The cir.get_method operation takes a method and an object as input, and yields a function pointer that points to the actual function corresponding to the input method. The operation also applies any necessary adjustments to the input object pointer for calling the method and yields the adjusted pointer.

This operation is generated when calling a method through a pointer-to- member-function in C++:

// Foo *object;
// int arg;
// void (Foo::*method)(int);

(object->*method)(arg);

The code above will generate CIR similar as:

// %object = ...
// %arg = ...
// %method = ...
%callee, %this = cir.get_method %method, %object
cir.call %callee(%this, %arg)

The method type must match the callee type. That is:

• The return type of the method must match the return type of the callee.
• The first parameter of the callee must have type !cir.ptr<!cir.void>.
• Types of other parameters of the callee must match the parameters of the method.

Operands:

Results:

cir.get_runtime_member (::cir::GetRuntimeMemberOp)

Get the address of a member of a record

Syntax:

operation ::= `cir.get_runtime_member` $addr `[` $member `:` qualified(type($member)) `]` attr-dict
              `:` qualified(type($addr)) `->` qualified(type($result))

The cir.get_runtime_member operation gets the address of a member from the input record. The target member is given by a value of type !cir.data_member (i.e. a pointer-to-data-member value).

This operation differs from cir.get_member in when the target member can be determined. For the cir.get_member operation, the target member is specified as a constant index so the member it returns access to is known when the operation is constructed. For the cir.get_runtime_member operation, the target member is given through a pointer-to-data-member value which is unknown until the program being compiled is executed. In other words, cir.get_member represents a normal member access through the . operator in C/C++:

struct Foo { int x; };
Foo f;
(void)f.x;  // cir.get_member

And cir.get_runtime_member represents a member access through the .* or the ->* operator in C++:

struct Foo { int x; }
Foo f;
Foo *p;
int Foo::*member;

(void)f.*member;   // cir.get_runtime_member
(void)f->*member;  // cir.get_runtime_member

This operation expects a pointer to the base record as well as the pointer to the target member.

Operands:

Results:

cir.global (::cir::GlobalOp)

Declares or defines a global variable

Syntax:

operation ::= `cir.global` ($sym_visibility^)?
              (`` $global_visibility^)?
              (`constant` $constant^)?
              $linkage
              (`comdat` $comdat^)?
              ($tls_model^)?
              (`dsolocal` $dsolocal^)?
              (`addrspace` `(` custom<GlobalOpAddrSpace>($addr_space)^ `)`)?
              $sym_name
              custom<GlobalOpTypeAndInitialValue>($sym_type, $initial_value, $ctorRegion, $dtorRegion)
              ($annotations^)?
              attr-dict

The cir.global operation declares or defines a named global variable.

The backing memory for the variable is allocated statically and is described by the type of the variable.

The operation is a declaration if no inital_value is specified, else it is a definition.

The global variable can also be marked constant using the constant unit attribute. Writing to such constant global variables is undefined.

The linkage tracks C/C++ linkage types, currently very similar to LLVM's. Symbol visibility in sym_visibility is defined in terms of MLIR's visibility and verified to be in accordance to linkage.

visibility_attr is defined in terms of CIR's visibility.

Example:

// Public and constant variable with initial value.
cir.global public constant @c : i32 = 4;

Traits: NoRegionArguments

Interfaces: CIRGlobalValueInterface, RegionBranchOpInterface, Symbol

Attributes:

cir.goto (::cir::GotoOp)

Syntax:

operation ::= `cir.goto` $label attr-dict

Transfers control to the specified label. This requires a corresponding cir.label to exist and is used by to represent source level gotos that jump across region boundaries. Alternatively, cir.br is used to construct goto's that don't violate such boundaries.

cir.goto is completely symbolic (i.e. it "jumps" on a label that isn't yet materialized) and should be taken into account by passes and analysis when deciding if it's safe to make some assumptions about a given region or basic block.

Example:

  int test(int x) {
    if (x)
      goto label;
    {
      x = 10;
  label:
      return x;
    }
  }

  cir.scope {  // REGION #1
    %2 = cir.load %0 : !cir.ptr<!s32i>, !s32i
    %3 = cir.cast(int_to_bool, %2 : !s32i), !cir.bool
    cir.if %3 {
      cir.goto "label"
    }
    }
    cir.scope {  // REGION #2
      %2 = cir.const #cir.int<10> : !s32i
      cir.store %2, %0 : !s32i, !cir.ptr<!s32i>
      cir.br ^bb1
    ^bb1:  // pred: ^bb0
      cir.label "label"
      %3 = cir.load %0 : !cir.ptr<!s32i>, !s32i
      cir.store %3, %1 : !s32i, !cir.ptr<!s32i>
      %4 = cir.load %1 : !cir.ptr<!s32i>, !s32i
      cir.return %4 : !s32i
    }
    cir.unreachable

Traits: Terminator

Attributes:

cir.if (::cir::IfOp)

The if-then-else operation

The cir.if operation represents an if-then-else construct for conditionally executing two regions of code. The operand is a cir.bool type.

Examples:

cir.if %b  {
  ...
} else {
  ...
}

cir.if %c  {
  ...
}

cir.if %c  {
  ...
  cir.br ^a
^a:
  cir.yield
}

cir.if defines no values and the ‘else' can be omitted. The if/else regions must be terminated. If the region has only one block, the terminator can be left out, and cir.yield terminator will be inserted implictly. Otherwise, the region must be explicitly terminated.

Traits: AutomaticAllocationScope, NoRegionArguments, RecursivelySpeculatableImplTrait

Interfaces: ConditionallySpeculatable, RegionBranchOpInterface

Operands:

cir.insert_member (::cir::InsertMemberOp)

Overwrite the value of a member of a record value

Syntax:

operation ::= `cir.insert_member` $record `[` $index_attr `]` `,` $value attr-dict
              `:` qualified(type($record)) `,` qualified(type($value))

The cir.insert_member operation overwrites the value of a particular member in the input record value, and returns the modified record value. The result of this operation is equal to the input record value, except for the member specified by index_attr whose value is equal to the given value.

This operation is named after the LLVM instruction insertvalue.

Currently cir.insert_member does not work on unions.

Example:

// Suppose we have a record with multiple members.
!s32i = !cir.int<s, 32>
!s8i = !cir.int<s, 32>
!record_ty = !cir.record<"struct.Bar" {!s32i, !s8i}>

// And suppose we have a value of the record type.
%0 = cir.const #cir.const_record<{#cir.int<1> : !s32i, #cir.int<2> : !s8i}> : !record_ty
// %0 is {1, 2}

// Overwrite the second member of the record value.
%1 = cir.const #cir.int<3> : !s8i
%2 = cir.insert_member %0[1], %1 : !record_ty, !s8i
// %2 is {1, 3}

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.invariant_group (::cir::InvariantGroupOp)

Start an invariant group

Syntax:

operation ::= `cir.invariant_group` $ptr `:` type($result) attr-dict

The cir.invariant_group operation takes a single pointer value as argument and returns the same pointer value with fresh invariant group information. All loads and stores that access the returned pointer value are presumed by the optimizer to load or store the same value.

This operation is not emitted during CIRGen. Instead, it is created when hoisting constant alloca operations to the entry block of a function. This operation effectively marks the syntactic scope of the constant local variable represented by the hosited alloca operation, and it allows for better LLVMIR generation with potentially more optimizations.

For example, if we have the following CIR before alloca hoisting:

cir.func @foo() {
  cir.scope {
    %0 = cir.alloca !s32i : !cir.ptr<!s32i>
    use(%0)
  }
}

After alloca hoisting:

cir.func @foo() {
  %0 = cir.alloca !s32i : !cir.ptr<!s32i>
  cir.scope {
    %1 = cir.invariant_group %0 : !cir.ptr<!s32i>
    use(%1)
  }
}

During LLVMIR lowering, load and store operations whose pointer operand comes from cir.invariant_group are lowered to corresponding LLVM instructions with invariant group metadata attached.

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.is_constant (::cir::IsConstantOp)

Syntax:

operation ::= `cir.is_constant` `(` $val `:` type($val) `)` `:` type($result) attr-dict

Returns true if the argument is known to be a compile-time constant otherwise returns ‘false'.

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.is_fp_class (::cir::IsFPClassOp)

Corresponding to the __builtin_fpclassify builtin function in clang

Syntax:

operation ::= `cir.is_fp_class` $src `,` $flags `:` functional-type($src, $result) attr-dict

The cir.is_fp_class operation takes a floating-point value as its first argument and a bitfield of flags as its second argument. The operation returns a boolean value indicating whether the floating-point value satisfies the given flags.

The flags must be a compile time constant and the values are:

Interfaces: InferTypeOpInterface

Attributes:

Operands:

Results:

cir.std.begin (::cir::IterBeginOp)

Std::begin()

Syntax:

operation ::= `cir.std.begin` `(` $container `:` type($container) `,` $original_fn `)` `->` type($result) attr-dict

Attributes:

Operands:

Results:

cir.std.end (::cir::IterEndOp)

Std::end()

Syntax:

operation ::= `cir.std.end` `(` $container `:` type($container) `,` $original_fn `)` `->` type($result) attr-dict

Attributes:

Operands:

Results:

cir.llvm.intrinsic (::cir::LLVMIntrinsicCallOp)

Call to llvm intrinsic functions that is not defined in CIR

Syntax:

operation ::= `cir.llvm.intrinsic` $intrinsic_name $arg_ops `:` functional-type($arg_ops, $result) attr-dict

cir.llvm.intrinsic operation represents a call-like expression which has return type and arguments that maps directly to a llvm intrinsic. It only records intrinsic intrinsic_name.

Attributes:

Operands:

Results:

cir.llrint (::cir::LLrintOp)

Builtin function that takes a floating-point value as input and produces an integral value as output.

Syntax:

operation ::= `cir.llrint` $src `:` type($src) `->` type($result) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.llround (::cir::LLroundOp)

Builtin function that takes a floating-point value as input and produces an integral value as output.

Syntax:

operation ::= `cir.llround` $src `:` type($src) `->` type($result) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.label (::cir::LabelOp)

Syntax:

operation ::= `cir.label` $label attr-dict

An identifier which may be referred by cir.goto operation

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable

Attributes:

cir.linker_options (::cir::LinkerOptionsOp)

Options to pass to the linker when the object file is linked

Syntax:

operation ::= `cir.linker_options` $options attr-dict

Pass the given options to the linker when the resulting object file is linked. This is used extensively on Windows to determine the C runtime that the object files should link against.

Examples:

// Link against the MSVC static threaded CRT.
cir.linker_options ["/DEFAULTLIB:", "libcmt"]

// Link against aarch64 compiler-rt builtins
cir.linker_options ["-l", "clang_rt.builtins-aarch64"]

Traits: `HasParent<mlir::ModuleOp>`

#### Attributes:

<table>
<tr><th>Attribute</th><th>MLIR Type</th><th>Description</th></tr>
<tr><td><code>options</code></td><td>::mlir::ArrayAttr</td><td>string array attribute</td></tr>
</table>


### `cir.load` (::cir::LoadOp)

_Load value from memory adddress_

Syntax:

operation ::= cir.load (deref $isDeref^)? (volatile $is_volatile^)? (nontemporal $is_nontemporal^)? (align ( $alignment^ ))? (atomic ( $mem_order^ ))? $addr : qualified(type($addr)) , type($result) attr-dict (tbaa ( $tbaa^ ))?

`cir.load` reads a value (lvalue to rvalue conversion) given an address
backed up by a `cir.ptr` type. A unit attribute `deref` can be used to
mark the resulting value as used by another operation to dereference
a pointer. A unit attribute `volatile` can be used to indicate a volatile
loading. Load can be marked atomic by using `atomic(<mem_order>)`.

`align` can be used to specify an alignment that's different from the
default, which is computed from `result`'s type ABI data layout.

Example:

```mlir

// Read from local variable, address in %0.
%1 = cir.load %0 : !cir.ptr<i32>, i32

// Load address from memory at address %0. %3 is used by at least one
// operation that dereferences a pointer.
%3 = cir.load deref %0 : !cir.ptr<!cir.ptr<i32>>

// Perform a volatile load from address in %0.
%4 = cir.load volatile %0 : !cir.ptr<i32>, i32

// Others
%x = cir.load align(16) atomic(seq_cst) %0 : !cir.ptr<i32>, i32

Interfaces: InferTypeOpInterface, PromotableMemOpInterface

Attributes:

Operands:

Results:

cir.log10 (::cir::Log10Op)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.log10` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.log2 (::cir::Log2Op)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.log2` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.log (::cir::LogOp)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.log` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.lrint (::cir::LrintOp)

Builtin function that takes a floating-point value as input and produces an integral value as output.

Syntax:

operation ::= `cir.lrint` $src `:` type($src) `->` type($result) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.lround (::cir::LroundOp)

Builtin function that takes a floating-point value as input and produces an integral value as output.

Syntax:

operation ::= `cir.lround` $src `:` type($src) `->` type($result) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.libc.memchr (::cir::MemChrOp)

Libc's memchr

Syntax:

operation ::= `cir.libc.memchr` `(`
              $src `,` $pattern `,` $len `)` attr-dict

Search for pattern in data range from src to src + len. provides a bound to the search in src. result is a pointer to found pattern or a null pointer.

Examples:

%p = cir.libc.memchr(%src, %pattern, %len) -> !cir.ptr<!void>

Interfaces: InferTypeOpInterface

Operands:

Results:

cir.memcpy_inline (::cir::MemCpyInlineOp)

Memory copy with constant length without callingany external function

Syntax:

operation ::= `cir.memcpy_inline` $len `bytes` `from` $src `to` $dst attr-dict
              `:` qualified(type($src)) `->` qualified(type($dst))

Given two CIR pointers, src and dst, memcpy_inline will copy len bytes from the memory pointed by src to the memory pointed by dst.

Unlike cir.libc.memcpy, this Op guarantees that no external functions are called, and length of copied bytes is a constant.

Examples:

  // Copying 2 bytes from one array to a record:
  cir.memcpy_inline 2 bytes from %arr to %record : !cir.ptr<!arr> -> !cir.ptr<!record>

Attributes:

Operands:

cir.libc.memcpy (::cir::MemCpyOp)

Equivalent to libc's memcpy

Syntax:

operation ::= `cir.libc.memcpy` $len `bytes` `from` $src `to` $dst attr-dict
              `:` type($len) `` `,` qualified(type($src)) `->` qualified(type($dst))

Given two CIR pointers, src and dst, cir.libc.memcpy will copy len bytes from the memory pointed by src to the memory pointed by dst.

While cir.copy is meant to be used for implicit copies in the code where the length of the copy is known, cir.memcpy copies only from and to void pointers, requiring the copy length to be passed as an argument.

Examples:

  // Copying 2 bytes from one array to a record:
  %2 = cir.const #cir.int<2> : !u32i
  cir.libc.memcpy %2 bytes from %arr to %record : !cir.ptr<!arr> -> !cir.ptr<!record>

Operands:

cir.libc.memmove (::cir::MemMoveOp)

Equivalent to libc's memmove

Syntax:

operation ::= `cir.libc.memmove` $len `bytes` `from` $src `to` $dst attr-dict
              `:` qualified(type($dst)) `,` type($len)

Given two CIR pointers, src and dst, cir.libc.memmove will copy len bytes from the memory pointed by src to the memory pointed by dst.

similiar to cir.libc.memcpy but accounts for overlapping memory.

Examples:

  // Copying 2 bytes from one array to a record:
  %2 = cir.const #cir.int<2> : !u32i
  cir.libc.memmove %2 bytes from %arr to %record : !cir.ptr<!void>, !u64i

Operands:

cir.memset_inline (::cir::MemSetInlineOp)

Fill a block of memory with constant length without callingany external function

Syntax:

operation ::= `cir.memset_inline` $len `bytes` `from` $dst `set` `to` $val attr-dict
              `:` qualified(type($dst)) `,` type($val)

Given the CIR pointer, dst, cir.memset_inline will set the first len bytes of the memory pointed by dst to the specified val.

The len argument must be a constant integer argument specifying the number of bytes to fill.

Examples:

  // Set 2 bytes from a record to 0
  cir.memset_inline 2 bytes from %record set to %zero : !cir.ptr<!void>, !s32i

Attributes:

Operands:

cir.libc.memset (::cir::MemSetOp)

Equivalent to libc's memset

Syntax:

operation ::= `cir.libc.memset` $len `bytes` `from` $dst `set` `to` $val attr-dict
              `:` qualified(type($dst)) `,` type($val) `,` type($len)

Given the CIR pointer, dst, cir.libc.memset will set the first len bytes of the memory pointed by dst to the specified val.

Examples:

  // Set 2 bytes from a record to 0:
  %2 = cir.const #cir.int<2> : !u32i
  %3 = cir.const #cir.int<0> : !u32i
  %zero = cir.cast(integral, %3 : !s32i), !u8i
  cir.libc.memset %2 bytes from %record set to %zero : !cir.ptr<!void>, !s32i, !u64i

Operands:

cir.nearbyint (::cir::NearbyintOp)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.nearbyint` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.objsize (::cir::ObjSizeOp)

Conversion between values of different types

Syntax:

operation ::= `cir.objsize` `(`
              $ptr `:` type($ptr) `,`
              $kind
              (`,` `dynamic` $dynamic^)?
              `)`
              `->` type($result) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.pow (::cir::PowOp)

Libc builtin equivalent ignoring floating-point exceptions and errno.

Syntax:

operation ::= `cir.pow` $lhs `,` $rhs `:` qualified(type($lhs)) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.prefetch (::cir::PrefetchOp)

Prefetch operation

Syntax:

operation ::= `cir.prefetch` `(` $addr `:` qualified(type($addr)) `)`
              `locality``(` $locality `)`
              (`write` $isWrite^) : (`read`)?
              attr-dict

The cir.prefetch op prefetches data from the memmory address.

cir.prefetch(%0 : !cir.ptr<!void>) locality(1) write

This opcode has the three attributes:

1. The $locality is a temporal locality specifier ranging from (0) - no locality, to (3) - extremely local keep in cache.
2. The $isWrite is the specifier determining if the prefetch is prepaired for a ‘read' or ‘write'. If $isWrite doesn't specified it means that prefetch is prepared for ‘read'.

Attributes:

Operands:

cir.ptr_diff (::cir::PtrDiffOp)

Pointer subtraction arithmetic

Syntax:

operation ::= `cir.ptr_diff` `(` $lhs `,` $rhs  `)` `:` qualified(type($lhs)) `->` qualified(type($result)) attr-dict

cir.ptr_diff performs a subtraction between two pointer types with the same element type and produces a cir::IntType result.

Note that the result considers the pointer size according to the ABI for the pointee sizes, e.g. the subtraction between two !cir.ptr<!u64i> might yield 1, meaning 8 bytes, whereas for void or function type pointees, yielding 8 means 8 bytes.

%7 = "cir.ptr_diff"(%0, %1) : !cir.ptr<!u64i> -> !u64i

Traits: AlwaysSpeculatableImplTrait, SameTypeOperands

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.ptr_mask (::cir::PtrMaskOp)

Masks out bits of the pointer according to a mask

Syntax:

operation ::= `cir.ptr_mask` `(` $ptr `,` $mask `:` type($mask) `)` `:` qualified(type($result)) attr-dict

The cir.ptr_mask operation takes a pointer and an interger mask as its argument and return the masked pointer type according to the mask.

Interfaces: InferTypeOpInterface

Operands:

Results:

cir.ptr_stride (::cir::PtrStrideOp)

Pointer access with stride

Syntax:

operation ::= `cir.ptr_stride` `(` $base `:` qualified(type($base)) `,` $stride `:` qualified(type($stride)) `)`
              `,` qualified(type($result)) attr-dict

Given a base pointer as first operand, provides a new pointer after applying a stride (second operand).

%3 = cir.const 0 : i32
%4 = cir.ptr_stride(%2 : !cir.ptr<i32>, %3 : i32), !cir.ptr<i32>

Traits: AlwaysSpeculatableImplTrait, SameFirstOperandAndResultType

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.resume (::cir::ResumeOp)

Resumes execution after not catching exceptions

Syntax:

operation ::= `cir.resume` ($rethrow^)?
              ($exception_ptr^)?
              (`,` $type_id^)?
              attr-dict

The cir.resume operation handles an uncaught exception scenario and behaves in two different modes:

• As the terminator of a CatchUnwind region of cir.try, where it does not receive any arguments (implied from the cir.try scope), or
• The terminator of a regular basic block without an enclosing cir.try operation, where it requires an exception_ptr and a type_id.

The rethrow attribute is used to denote rethrowing behavior for the resume operation (versus default terminaton).

Traits: `AttrSizedOperandSegments`, `ReturnLike`, `Terminator`

Interfaces: `RegionBranchTerminatorOpInterface`

#### Attributes:

<table>
<tr><th>Attribute</th><th>MLIR Type</th><th>Description</th></tr>
<tr><td><code>rethrow</code></td><td>::mlir::UnitAttr</td><td>unit attribute</td></tr>
</table>

#### Operands:

| Operand | Description |
| :-----: | ----------- |
| `exception_ptr` | pointer to void type |
| `type_id` | 32-bit unsigned integer |


### `cir.return_address` (::cir::ReturnAddrOp)

_The return address of the current function, or of one of its callers_

Syntax:

operation ::= cir.return_address ( $level ) attr-dict

Represents call to builtin function ` __builtin_return_address` in CIR.
This builtin function returns the return address of the current function,
or of one of its callers.
The `level` argument is number of frames to scan up the call stack.
For instance, value of 0 yields the return address of the current function,
value of 1 yields the return address of the caller of the current function,
and so forth.

Examples:

```mlir
%p = return_address(%level) -> !cir.ptr<!void>

Interfaces: InferTypeOpInterface

Operands:

Results:

cir.return (::cir::ReturnOp)

Return from function

Syntax:

operation ::= `cir.return` ($input^ `:` type($input))? attr-dict

The "return" operation represents a return operation within a function. The operation takes an optional operand and produces no results. The operand type must match the signature of the function that contains the operation.

  func @foo() -> i32 {
    ...
    cir.return %0 : i32
  }

Traits: HasParent<FuncOp, ScopeOp, IfOp, SwitchOp, DoWhileOp, WhileOp, ForOp, CaseOp, TryOp>, Terminator

Operands:

cir.rint (::cir::RintOp)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.rint` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.rotate (::cir::RotateOp)

Reverse the bytes that constitute the operand integer

Syntax:

operation ::= `cir.rotate` (`left` $left^) : (`right`)?
              $src `,` $amt `->` type($result) attr-dict

The cir.rotate rotates operand in src by the given bit amount amt. Its widths must be either 8, 16, 32, or 64 and both src, amt and result be of the same type. The rotate direction is specified by a left/right keyword.

This operation covers different C/C++ builtins, some examples: __builtin_rotateleft8, __builtin_rotateleft16, __builtin_rotateleft32, __builtin_rotateleft64, _rotl8, _rotl16, _rotl, _lrotl, _rotl64, etc and their "right" variants.

Example:

%r = cir.rotate left %0, %1 -> !u32i

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.roundeven (::cir::RoundEvenOp)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.roundeven` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.round (::cir::RoundOp)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.round` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.scope (::cir::ScopeOp)

Represents a C/C++ scope

Syntax:

operation ::= `cir.scope` custom<OmittedTerminatorRegion>($scopeRegion, $cleanupRegion) (`:` type($results)^)? attr-dict

cir.scope contains one region and defines a strict "scope" for all new values produced within its blocks.

The region can contain an arbitrary number of blocks but usually defaults to one and can optionally return a value (useful for representing values coming out of C++ full-expressions) via cir.yield:

%rvalue = cir.scope {
  ...
  cir.yield %value
}

The blocks can be terminated by cir.yield, cir.return or cir.throw. If cir.scope yields no value, the cir.yield can be left out, and will be inserted implicitly.

The scope might also have an associated cleanup region, providing code that run destruction of automatic variables. Note that in order to lower the cleanup region while keeping C++ semantics, all immediate control-flow breaking operations not under a children scope should jump to this cleanup code.

Traits: AutomaticAllocationScope, NoRegionArguments, RecursivelySpeculatableImplTrait

Interfaces: ConditionallySpeculatable, RegionBranchOpInterface

Results:

cir.select (::cir::SelectOp)

Yield one of two values based on a boolean value

Syntax:

operation ::= `cir.select` `if` $condition `then` $true_value `else` $false_value
              `:` `(`
              qualified(type($condition)) `,`
              qualified(type($true_value)) `,`
              qualified(type($false_value))
              `)` `->` qualified(type($result)) attr-dict

The cir.select operation takes three operands. The first operand condition is a boolean value of type !cir.bool. The second and the third operand can be of any CIR types, but their types must be the same. If the first operand is true, the operation yields its second operand. Otherwise, the operation yields its third operand.

Example:

%0 = cir.const #cir.bool<true> : !cir.bool
%1 = cir.const #cir.int<42> : !s32i
%2 = cir.const #cir.int<72> : !s32i
%3 = cir.select if %0 then %1 else %2 : (!cir.bool, !s32i, !s32i) -> !s32i

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.set_bitfield (::cir::SetBitfieldOp)

Set a bitfield

Syntax:

operation ::= `cir.set_bitfield` `(`$bitfield_info`,` $addr`:`qualified(type($addr))`,`
              $src`:`type($src) `)`  attr-dict `->` type($result)

The cir.set_bitfield operation provides a store-like access to a bit field of a record.

It expects an address of a storage where to store, a type of the storage, a value being stored, a name of a bit field, a pointer to the storage in the base record, a size of the storage, a size the bit field, an offset of the bit field and a sign. Returns a value being stored.

A unit attribute volatile can be used to indicate a volatile load of the bitfield.

Example. Suppose we have a struct with multiple bitfields stored in different storages. The cir.set_bitfield operation sets the value of the bitfield.

typedef struct {
  int a : 4;
  int b : 27;
  int c : 17;
  int d : 2;
  int e : 15;
} S;

void store_bitfield(S& s) {
  s.d = 3;
}

// 'd' is in the storage with the index 1
!record_type = !cir.record<struct "S" {!cir.int<u, 32>, !cir.int<u, 32>, !cir.int<u, 16>} #cir.record.decl.ast>
#bfi_d = #cir.bitfield_info<name = "d", storage_type = !u32i, size = 2, offset = 17, is_signed = true>

%1 = cir.const #cir.int<3> : !s32i
%2 = cir.load %0 : !cir.ptr<!cir.ptr<!record_type>>, !cir.ptr<!record_type>
%3 = cir.get_member %2[1] {name = "d"} : !cir.ptr<!record_type> -> !cir.ptr<!u32i>
%4 = cir.set_bitfield(#bfi_d, %3 : !cir.ptr<!u32i>, %1 : !s32i) -> !s32i

Attributes:

Operands:

Results:

cir.shift (::cir::ShiftOp)

Shift

Syntax:

operation ::= `cir.shift` `(`
              (`left` $isShiftleft^) : (```right`)?
              `,` $value `:` type($value)
              `,` $amount `:` type($amount)
              `)` `->` type($result) attr-dict

Shift left or right, according to the first operand. Second operand is the shift target and the third the amount. Second and the thrid operand can be either integer type or vector of integer type. However, they must be either all vector of integer type, or all integer type. If they are vectors, each vector element of the shift target is shifted by the corresponding shift amount in the shift amount vector.

%7 = cir.shift(left, %1 : !u64i, %4 : !s32i) -> !u64i
%8 = cir.shift(left, %2 : !cir.vector<!s32i x 2>, %3 : !cir.vector<!s32i x 2>) -> !cir.vector<!s32i x 2>

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

cir.signbit (::cir::SignBitOp)

Checks the sign of a floating-point number

Syntax:

operation ::= `cir.signbit` $input attr-dict `:` type($input) `->` qualified(type($res))

It returns whether the sign bit (i.e. the highest bit) of the input operand is set.

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.sin (::cir::SinOp)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.sin` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.sqrt (::cir::SqrtOp)

Libc builtin equivalent ignoring floating point exceptions and errno

Syntax:

operation ::= `cir.sqrt` $src `:` type($src) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

cir.stack_restore (::cir::StackRestoreOp)

Restores the state of the function stack

Syntax:

operation ::= `cir.stack_restore` $ptr attr-dict `:` qualified(type($ptr))

Restore the state of the function stack to the state it was in when the corresponding cir.stack_save executed. Useful for implementing language features like variable length arrays.

%0 = cir.alloca !cir.ptr<!u8i>, !cir.ptr<!cir.ptr<!u8i>>, ["saved_stack"] {alignment = 8 : i64}
%1 = cir.stack_save : <!u8i>
cir.store %1, %0 : !cir.ptr<!u8i>, !cir.ptr<!cir.ptr<!u8i>>
%2 = cir.load %0 : !cir.ptr<!cir.ptr<!u8i>>, !cir.ptr<!u8i>
cir.stack_restore %2 : !cir.ptr<!u8i>

Operands:

cir.stack_save (::cir::StackSaveOp)

Remembers the current state of the function stack

Syntax:

operation ::= `cir.stack_save` attr-dict `:` qualified(type($result))

Remembers the current state of the function stack. Returns a pointer that later can be passed into cir.stack_restore. Useful for implementing language features like variable length arrays.

%0 = cir.stack_save : <!u8i>

Results:

cir.std.find (::cir::StdFindOp)

Std::find()

Syntax:

operation ::= `cir.std.find` `(` $first `:` type($first) `,` $last `:` type($last) `,` $pattern `:` type($pattern) `,` $original_fn `)` `->` type($result) attr-dict

Traits: SameFirstSecondOperandAndResultType

Attributes:

Operands:

Results:

cir.store (::cir::StoreOp)

Store value to memory address

Syntax:

operation ::= `cir.store` (`volatile` $is_volatile^)?
              (`nontemporal` $is_nontemporal^)?
              (`align` `(` $alignment^ `)`)?
              (`atomic` `(` $mem_order^ `)`)?
              $value `,` $addr attr-dict `:` type($value) `,` qualified(type($addr))
              (`tbaa` `(` $tbaa^ `)`)?

cir.store stores a value (first operand) to the memory address specified in the second operand. A unit attribute volatile can be used to indicate a volatile store. Store's can be marked atomic by using atomic(<mem_order>).

align can be used to specify an alignment that's different from the default, which is computed from result's type ABI data layout.

Example:

// Store a function argument to local storage, address in %0.
cir.store %arg0, %0 : i32, !cir.ptr<i32>

// Perform a volatile store into memory location at the address in %0.
cir.store volatile %arg0, %0 : i32, !cir.ptr<i32>

// Others
cir.store align(16) atomic(seq_cst) %x, %addr : i32, !cir.ptr<i32>

Interfaces: PromotableMemOpInterface

Attributes:

Operands:

cir.switch.flat (::cir::SwitchFlatOp)

Syntax:

operation ::= `cir.switch.flat` $condition `:` type($condition) `,`
              $defaultDestination (`(` $defaultOperands^ `:` type($defaultOperands) `)`)?
              custom<SwitchFlatOpCases>(ref(type($condition)), $case_values, $caseDestinations,
              $caseOperands, type($caseOperands))
              attr-dict

The cir.switch.flat operation is a region-less and simplified version of the cir.switch. It's representation is closer to LLVM IR dialect than the C/C++ language feature.

Traits: AttrSizedOperandSegments, Terminator

Attributes:

Operands:

Successors:

cir.switch (::cir::SwitchOp)

Switch operation

Syntax:

operation ::= `cir.switch` custom<SwitchOp>(
              $body, $condition, type($condition)
              )
              attr-dict