mlir::OpBuilder Class Reference

This class helps build Operations. More...

#include "mlir/IR/Builders.h"

Inheritance diagram for mlir::OpBuilder:

Classes
class	InsertionGuard
	RAII guard to reset the insertion point of the builder when destroyed. More...
class	InsertPoint
	This class represents a saved insertion point. More...
struct	Listener
	This class represents a listener that may be used to hook into various actions within an OpBuilder. More...
struct	ListenerBase
	Base class for listeners. More...

Public Member Functions
	OpBuilder (MLIRContext *ctx, Listener *listener=nullptr)
	Create a builder with the given context. More...
	OpBuilder (Region *region, Listener *listener=nullptr)
	Create a builder and set the insertion point to the start of the region. More...
	OpBuilder (Region &region, Listener *listener=nullptr)
	OpBuilder (Operation *op, Listener *listener=nullptr)
	Create a builder and set insertion point to the given operation, which will cause subsequent insertions to go right before it. More...
	OpBuilder (Block *block, Block::iterator insertPoint, Listener *listener=nullptr)
void	setListener (Listener *newListener)
	Sets the listener of this builder to the one provided. More...
Listener *	getListener () const
	Returns the current listener of this builder, or nullptr if this builder doesn't have a listener. More...
void	clearInsertionPoint ()
	Reset the insertion point to no location. More...
InsertPoint	saveInsertionPoint () const
	Return a saved insertion point. More...
void	restoreInsertionPoint (InsertPoint ip)
	Restore the insert point to a previously saved point. More...
void	setInsertionPoint (Block *block, Block::iterator insertPoint)
	Set the insertion point to the specified location. More...
void	setInsertionPoint (Operation *op)
	Sets the insertion point to the specified operation, which will cause subsequent insertions to go right before it. More...
void	setInsertionPointAfter (Operation *op)
	Sets the insertion point to the node after the specified operation, which will cause subsequent insertions to go right after it. More...
void	setInsertionPointAfterValue (Value val)
	Sets the insertion point to the node after the specified value. More...
void	setInsertionPointToStart (Block *block)
	Sets the insertion point to the start of the specified block. More...
void	setInsertionPointToEnd (Block *block)
	Sets the insertion point to the end of the specified block. More...
Block *	getInsertionBlock () const
	Return the block the current insertion point belongs to. More...
Block::iterator	getInsertionPoint () const
	Returns the current insertion point of the builder. More...
Block *	getBlock () const
	Returns the current block of the builder. More...
Block *	createBlock (Region *parent, Region::iterator insertPt={}, TypeRange argTypes=std::nullopt, ArrayRef< Location > locs=std::nullopt)
	Add new block with 'argTypes' arguments and set the insertion point to the end of it. More...
Block *	createBlock (Block *insertBefore, TypeRange argTypes=std::nullopt, ArrayRef< Location > locs=std::nullopt)
	Add new block with 'argTypes' arguments and set the insertion point to the end of it. More...
Operation *	insert (Operation *op)
	Insert the given operation at the current insertion point and return it. More...
Operation *	create (const OperationState &state)
	Creates an operation given the fields represented as an OperationState. More...
Operation *	create (Location loc, StringAttr opName, ValueRange operands, TypeRange types={}, ArrayRef< NamedAttribute > attributes={}, BlockRange successors={}, MutableArrayRef< std::unique_ptr< Region >> regions={})
	Creates an operation with the given fields. More...
template<typename OpTy , typename... Args>
OpTy	create (Location location, Args &&...args)
	Create an operation of specific op type at the current insertion point. More...
template<typename OpTy , typename... Args>
void	createOrFold (SmallVectorImpl< Value > &results, Location location, Args &&...args)
	Create an operation of specific op type at the current insertion point, and immediately try to fold it. More...
template<typename OpTy , typename... Args>
std::enable_if_t< OpTy::template hasTrait< OpTrait::OneResult >), Value >	createOrFold (Location location, Args &&...args)
	Overload to create or fold a single result operation. More...
template<typename OpTy , typename... Args>
std::enable_if_t< OpTy::template hasTrait< OpTrait::ZeroResults >), OpTy >	createOrFold (Location location, Args &&...args)
	Overload to create or fold a zero result operation. More...
LogicalResult	tryFold (Operation *op, SmallVectorImpl< Value > &results)
	Attempts to fold the given operation and places new results within 'results'. More...
Operation *	clone (Operation &op, IRMapping &mapper)
	Creates a deep copy of the specified operation, remapping any operands that use values outside of the operation using the map that is provided ( leaving them alone if no entry is present). More...
Operation *	clone (Operation &op)
Operation *	cloneWithoutRegions (Operation &op, IRMapping &mapper)
	Creates a deep copy of this operation but keep the operation regions empty. More...
Operation *	cloneWithoutRegions (Operation &op)
template<typename OpT >
OpT	cloneWithoutRegions (OpT op)
Public Member Functions inherited from mlir::Builder
	Builder (MLIRContext *context)
	Builder (Operation *op)
MLIRContext *	getContext () const
Location	getUnknownLoc ()
Location	getFusedLoc (ArrayRef< Location > locs, Attribute metadata=Attribute())
FloatType	getFloat8E5M2Type ()
FloatType	getFloat8E4M3FNType ()
FloatType	getFloat8E5M2FNUZType ()
FloatType	getFloat8E4M3FNUZType ()
FloatType	getFloat8E4M3B11FNUZType ()
FloatType	getBF16Type ()
FloatType	getF16Type ()
FloatType	getF32Type ()
FloatType	getF64Type ()
FloatType	getF80Type ()
FloatType	getF128Type ()
IndexType	getIndexType ()
IntegerType	getI1Type ()
IntegerType	getI2Type ()
IntegerType	getI4Type ()
IntegerType	getI8Type ()
IntegerType	getI16Type ()
IntegerType	getI32Type ()
IntegerType	getI64Type ()
IntegerType	getIntegerType (unsigned width)
IntegerType	getIntegerType (unsigned width, bool isSigned)
FunctionType	getFunctionType (TypeRange inputs, TypeRange results)
TupleType	getTupleType (TypeRange elementTypes)
NoneType	getNoneType ()
template<typename Ty , typename... Args>
Ty	getType (Args &&...args)
	Get or construct an instance of the type Ty with provided arguments. More...
template<typename Attr , typename... Args>
Attr	getAttr (Args &&...args)
	Get or construct an instance of the attribute Attr with provided arguments. More...
NamedAttribute	getNamedAttr (StringRef name, Attribute val)
UnitAttr	getUnitAttr ()
BoolAttr	getBoolAttr (bool value)
DictionaryAttr	getDictionaryAttr (ArrayRef< NamedAttribute > value)
IntegerAttr	getIntegerAttr (Type type, int64_t value)
IntegerAttr	getIntegerAttr (Type type, const APInt &value)
FloatAttr	getFloatAttr (Type type, double value)
FloatAttr	getFloatAttr (Type type, const APFloat &value)
StringAttr	getStringAttr (const Twine &bytes)
ArrayAttr	getArrayAttr (ArrayRef< Attribute > value)
TypedAttr	getZeroAttr (Type type)
FloatAttr	getF16FloatAttr (float value)
FloatAttr	getF32FloatAttr (float value)
FloatAttr	getF64FloatAttr (double value)
IntegerAttr	getI8IntegerAttr (int8_t value)
IntegerAttr	getI16IntegerAttr (int16_t value)
IntegerAttr	getI32IntegerAttr (int32_t value)
IntegerAttr	getI64IntegerAttr (int64_t value)
IntegerAttr	getIndexAttr (int64_t value)
IntegerAttr	getSI32IntegerAttr (int32_t value)
	Signed and unsigned integer attribute getters. More...
IntegerAttr	getUI32IntegerAttr (uint32_t value)
DenseIntElementsAttr	getBoolVectorAttr (ArrayRef< bool > values)
	Vector-typed DenseIntElementsAttr getters. values must not be empty. More...
DenseIntElementsAttr	getI32VectorAttr (ArrayRef< int32_t > values)
DenseIntElementsAttr	getI64VectorAttr (ArrayRef< int64_t > values)
DenseIntElementsAttr	getIndexVectorAttr (ArrayRef< int64_t > values)
DenseIntElementsAttr	getI32TensorAttr (ArrayRef< int32_t > values)
	Tensor-typed DenseIntElementsAttr getters. More...
DenseIntElementsAttr	getI64TensorAttr (ArrayRef< int64_t > values)
DenseIntElementsAttr	getIndexTensorAttr (ArrayRef< int64_t > values)
DenseBoolArrayAttr	getDenseBoolArrayAttr (ArrayRef< bool > values)
	Tensor-typed DenseArrayAttr getters. More...
DenseI8ArrayAttr	getDenseI8ArrayAttr (ArrayRef< int8_t > values)
DenseI16ArrayAttr	getDenseI16ArrayAttr (ArrayRef< int16_t > values)
DenseI32ArrayAttr	getDenseI32ArrayAttr (ArrayRef< int32_t > values)
DenseI64ArrayAttr	getDenseI64ArrayAttr (ArrayRef< int64_t > values)
DenseF32ArrayAttr	getDenseF32ArrayAttr (ArrayRef< float > values)
DenseF64ArrayAttr	getDenseF64ArrayAttr (ArrayRef< double > values)
ArrayAttr	getAffineMapArrayAttr (ArrayRef< AffineMap > values)
ArrayAttr	getBoolArrayAttr (ArrayRef< bool > values)
ArrayAttr	getI32ArrayAttr (ArrayRef< int32_t > values)
ArrayAttr	getI64ArrayAttr (ArrayRef< int64_t > values)
ArrayAttr	getIndexArrayAttr (ArrayRef< int64_t > values)
ArrayAttr	getF32ArrayAttr (ArrayRef< float > values)
ArrayAttr	getF64ArrayAttr (ArrayRef< double > values)
ArrayAttr	getStrArrayAttr (ArrayRef< StringRef > values)
ArrayAttr	getTypeArrayAttr (TypeRange values)
AffineExpr	getAffineDimExpr (unsigned position)
AffineExpr	getAffineSymbolExpr (unsigned position)
AffineExpr	getAffineConstantExpr (int64_t constant)
AffineMap	getEmptyAffineMap ()
	Returns a zero result affine map with no dimensions or symbols: () -> (). More...
AffineMap	getConstantAffineMap (int64_t val)
	Returns a single constant result affine map with 0 dimensions and 0 symbols. More...
AffineMap	getDimIdentityMap ()
AffineMap	getMultiDimIdentityMap (unsigned rank)
AffineMap	getSymbolIdentityMap ()
AffineMap	getSingleDimShiftAffineMap (int64_t shift)
	Returns a map that shifts its (single) input dimension by 'shift'. More...
AffineMap	getShiftedAffineMap (AffineMap map, int64_t shift)
	Returns an affine map that is a translation (shift) of all result expressions in 'map' by 'shift'. More...

Static Public Member Functions
static OpBuilder	atBlockBegin (Block *block, Listener *listener=nullptr)
	Create a builder and set the insertion point to before the first operation in the block but still inside the block. More...
static OpBuilder	atBlockEnd (Block *block, Listener *listener=nullptr)
	Create a builder and set the insertion point to after the last operation in the block but still inside the block. More...
static OpBuilder	atBlockTerminator (Block *block, Listener *listener=nullptr)
	Create a builder and set the insertion point to before the block terminator. More...

Protected Attributes
Listener *	listener
	The optional listener for events of this builder. More...
Protected Attributes inherited from mlir::Builder
MLIRContext *	context

Detailed Description

This class helps build Operations.

Operations that are created are automatically inserted at an insertion point. The builder is copyable.

Definition at line 202 of file Builders.h.

Constructor & Destructor Documentation

OpBuilder() [1/5]

mlir::OpBuilder::OpBuilder ( MLIRContext *  ctx, Listener *  listener = nullptr  )

inlineexplicit

Create a builder with the given context.

Definition at line 207 of file Builders.h.

Referenced by atBlockBegin(), atBlockEnd(), and atBlockTerminator().

OpBuilder() [2/5]

mlir::OpBuilder::OpBuilder ( Region *  region, Listener *  listener = nullptr  )

inlineexplicit

Create a builder and set the insertion point to the start of the region.

Definition at line 211 of file Builders.h.

References mlir::Block::begin(), mlir::Region::empty(), mlir::Region::front(), and setInsertionPoint().

OpBuilder() [3/5]

mlir::OpBuilder::OpBuilder ( Region &  region, Listener *  listener = nullptr  )

inlineexplicit

Definition at line 216 of file Builders.h.

OpBuilder() [4/5]

mlir::OpBuilder::OpBuilder ( Operation *  op, Listener *  listener = nullptr  )

inlineexplicit

Create a builder and set insertion point to the given operation, which will cause subsequent insertions to go right before it.

Definition at line 221 of file Builders.h.

OpBuilder() [5/5]

mlir::OpBuilder::OpBuilder ( Block *  block, Block::iterator  insertPoint, Listener *  listener = nullptr  )

inline

Definition at line 226 of file Builders.h.

References setInsertionPoint().

Member Function Documentation

atBlockBegin()

static OpBuilder mlir::OpBuilder::atBlockBegin ( Block *  block, Listener *  listener = nullptr  )

inlinestatic

Create a builder and set the insertion point to before the first operation in the block but still inside the block.

Definition at line 234 of file Builders.h.

References mlir::Block::begin(), listener, and OpBuilder().

Referenced by mlir::collapseParallelLoops(), getOrInsertPushConstantVariable(), and normalizeLoop().

atBlockEnd()

static OpBuilder mlir::OpBuilder::atBlockEnd ( Block *  block, Listener *  listener = nullptr  )

inlinestatic

Create a builder and set the insertion point to after the last operation in the block but still inside the block.

Definition at line 240 of file Builders.h.

References mlir::Block::end(), listener, and OpBuilder().

atBlockTerminator()

static OpBuilder mlir::OpBuilder::atBlockTerminator ( Block *  block, Listener *  listener = nullptr  )

inlinestatic

Create a builder and set the insertion point to before the block terminator.

Definition at line 246 of file Builders.h.

References mlir::Block::getTerminator(), listener, and OpBuilder().

Referenced by createFullTiles(), generatePointWiseCopy(), generateShiftedLoop(), generateUnrolledLoop(), and stripmineSink().

clearInsertionPoint()

void mlir::OpBuilder::clearInsertionPoint ( )

inline

Reset the insertion point to no location.

Creating an operation without a set insertion point is an error, but this can still be useful when the current insertion point a builder refers to is being removed.

Definition at line 360 of file Builders.h.

Referenced by restoreInsertionPoint().

clone() [1/2]

Operation * OpBuilder::clone

(

Operation &

op

)

Definition at line 536 of file Builders.cpp.

clone() [2/2]

Operation * OpBuilder::clone	(	Operation &	op,
		IRMapping &	mapper
	)

Creates a deep copy of the specified operation, remapping any operands that use values outside of the operation using the map that is provided ( leaving them alone if no entry is present).

Replaces references to cloned sub-operations to the corresponding operation that is copied, and adds those mappings to the map.

Definition at line 521 of file Builders.cpp.

Referenced by cloneAndFuseFirstUse(), createFullPartialVectorTransferRead(), createFullPartialVectorTransferWrite(), mlir::affine::fuseLoops(), generateCleanupLoopForUnroll(), hoistAffineIfOp(), mlir::affine::insertBackwardComputationSlice(), mlir::loopUnrollByFactor(), mlir::affine::loopUnrollJamByFactor(), mlir::makeRegionIsolatedFromAbove(), CanonicalizeContractAdd< AddOpType >::matchAndRewrite(), mlir::outlineSingleBlockRegion(), peelForLoop(), mlir::scf::promote(), mlir::vector::splitFullAndPartialTransfer(), and tileAndFuseFirstExtractUseThroughContainingOpBlockArgument().

cloneWithoutRegions() [1/3]

Operation* mlir::OpBuilder::cloneWithoutRegions ( Operation &  op )

inline

Definition at line 558 of file Builders.h.

cloneWithoutRegions() [2/3]

Operation* mlir::OpBuilder::cloneWithoutRegions ( Operation &  op, IRMapping &  mapper  )

inline

Creates a deep copy of this operation but keep the operation regions empty.

Operands are remapped using mapper (if present), and mapper is updated to contain the results.

Definition at line 555 of file Builders.h.

cloneWithoutRegions() [3/3]

template<typename OpT >

OpT mlir::OpBuilder::cloneWithoutRegions ( OpT  op )

inline

Definition at line 562 of file Builders.h.

create() [1/3]

Operation * OpBuilder::create

(

const OperationState &

state

)

Creates an operation given the fields represented as an OperationState.

Create an operation given the fields represented as an OperationState.

Definition at line 433 of file Builders.cpp.

References mlir::Operation::create(), and insert().

Referenced by mlir::ArithBuilder::_and(), mlir::ArithBuilder::add(), addAtomicRMW(), addBodyWithPayloadOp(), mlir::affine::affineParallelize(), mlir::UnrankedMemRefDescriptor::alignedPtr(), mlir::sparse_tensor::allocaBuffer(), mlir::UnrankedMemRefDescriptor::allocatedPtr(), allocateSubviewGPUMemoryInAddressSpace(), mlir::bufferization::allocateTensorForShapedValue(), mlir::sparse_tensor::allocDenseTensor(), alterGpuLaunch(), appendX1Dim(), applyPad(), bitAndAddrspaceCast(), broadcast(), mlir::tensor::bubbleUpPadSlice(), mlir::linalg::bufferizeToAllocation(), mlir::bufferization::BufferizeTypeConverter::BufferizeTypeConverter(), mlir::MemRefDescriptor::bufferPtr(), buildAffineLoopFromConstants(), buildAffineLoopFromValues(), buildAffineLoopNestImpl(), buildArithValue(), mlir::sparse_tensor::Merger::buildExp(), buildIdentityRegion(), mlir::tensor::buildIndependentOp(), mlir::scf::buildLoopNest(), buildMinMaxReductionSeq(), buildMultiDimReduce(), buildPackingLoopNestImpl(), mlir::scf::buildTerminatedBody(), mlir::vector::buildTerminatedBody(), buildVectorWrite(), calculateGatherOffset(), castAllocFuncResult(), mlir::vector::castAwayContractionLeadingOneDim(), castBoolToIntN(), castDataPtr(), castIntNToBool(), mlir::bufferization::castOrReallocMemRefValue(), castToElemPtrPtr(), ceilDivPositive(), checkAndNestUnderRewriteOp(), mlir::tosa::clampFloatHelper(), mlir::tosa::clampIntHelper(), mlir::affine::coalesceLoops(), mlir::coalesceLoops(), mlir::linalg::collapseGenericOpIterationDims(), collapseInnerDims(), mlir::collapseParallelLoops(), mlir::spirv::combine(), mlir::UnrankedMemRefDescriptor::computeSizes(), concatSizesFromInputs(), mlir::sparse_tensor::constantI1(), mlir::sparse_tensor::constantI16(), mlir::sparse_tensor::constantI32(), mlir::sparse_tensor::constantI64(), mlir::sparse_tensor::constantI8(), mlir::sparse_tensor::constantIndex(), mlir::sparse_tensor::constantOne(), mlir::sparse_tensor::constantZero(), constructTiledLoopNest(), convertIntrinsicResult(), mlir::convertScalarToDtype(), convertToLaunchFuncOp(), copy(), mlir::linalg::copyToGPUPrivateMemory(), mlir::linalg::copyToWorkgroupMemory(), mlir::ConvertToLLVMPattern::copyUnrankedDescriptors(), create(), createAdd(), mlir::linalg::createAdd(), mlir::AllocationOpLLVMLowering::createAligned(), mlir::bufferization::BufferizationOptions::createAlloc(), createAsyncDispatchFunction(), createBinarySearchFunc(), mlir::affine::createCanonicalizedAffineForOp(), createChoosePivot(), createCompareThenSwap(), createConst(), createConstantAllBitsSet(), createCtlzFunc(), mlir::bufferization::BufferizationOptions::createDealloc(), createDecl(), mlir::tensor::createDynamicDimValues(), createEqCompare(), mlir::linalg::GeneralizePadOpPattern::createFillOrGenerateOp(), createFloatConst(), createFoldedSLE(), createForAllDimensions(), createFPConstant(), createFullPartialLinalgCopy(), createFullPartialVectorTransferRead(), createFullPartialVectorTransferWrite(), mlir::sparse_tensor::createFuncCall(), mlir::LLVM::createGlobalString(), createGlobalVarForEntryPointArgument(), createGpuLaunch(), createGroupReduceOpImpl(), createHeapSortFunc(), createI32ConstantOf(), createInBoundsCond(), mlir::ConvertToLLVMPattern::createIndexAttrConstant(), createIndexAttrConstant(), mlir::AllocationOpLLVMLowering::createIndexConstant(), createInlinedCompareImplementation(), createInserts(), createIntConst(), createLessThanCompare(), mlir::bufferization::BufferizationOptions::createMemCpy(), createMul(), mlir::linalg::createMul(), createNewDynamicSizes(), mlir::sparse_tensor::createOrFoldSliceOffsetOp(), mlir::sparse_tensor::createOrFoldSliceStrideOp(), mlir::tensor::createPadHighOp(), createPartitionFunc(), createPrintMsg(), createPrivateMemRef(), createQuickSort(), createQuickSortFunc(), createScalarOrSplatConstant(), createScanLoop(), createSeparationCondition(), createShiftDownFunc(), createSortStableFunc(), createSubApply(), createSubTwoDividedByTwo(), createSubViewIntersection(), createSwap(), createSwitchOp(), mlir::sparse_tensor::deallocDenseTensor(), defaultDeallocBufferCallBack(), doit(), doubleBuffer(), mlir::bufferization::dropEquivalentBufferResults(), dropTrailingX1Dim(), elementwiseMatchAndRewriteHelper(), mlir::tensor::ExtractSliceFromCollapseHelper::emitLoopNestBody(), emitScalarImplementation(), emulateSignedRemainder(), endIf(), ensureDistinctSuccessors(), mlir::sparse_tensor::LoopEmitter::enterCoIterationOverTensorsAtLvls(), mlir::sparse_tensor::LoopEmitter::enterFilterLoopOverTensorAtLvl(), mlir::tosa::EqualizeRanks(), mlir::sparse_tensor::LoopEmitter::exitCurrentLoopSeq(), extendVectorRank(), extractConvFilterSlices(), extractConvInputSlices(), extractConvResultSlices(), mlir::extractFixedOuterLoops(), extractLastDimSlice(), extractOne(), mlir::StructBuilder::extractPtr(), finalizeWhileOp(), forEachIJPairInXs(), fromSliceCrd(), mlir::linalg::fuseElementwiseOps(), mlir::linalg::fuseProducerOfTensor(), fuseWithReshapeByExpansion(), mlir::sparse_tensor::genAlloca(), mlir::sparse_tensor::genAllocaScalar(), mlir::sparse_tensor::FuncCallOrInlineGenerator< SubClass >::genCallOrInline(), mlir::sparse_tensor::genCast(), genConstInt32From(), genCoordsAndValueForSparse(), mlir::linalg::generalizeNamedOp(), generateCollapsedIndexingRegion(), generateCopy(), generateFusedElementwiseOpRegion(), mlir::linalg::generateParallelLoopNest(), generatePointWiseCopy(), generateShiftedLoop(), generateTileLoopNest(), genIf(), mlir::sparse_tensor::genIndexLoad(), mlir::sparse_tensor::genIsNonzero(), mlir::sparse_tensor::genReshapeDstShape(), genSplitSparseConstant(), mlir::sparse_tensor::genToCoordinates(), mlir::sparse_tensor::genToCoordinatesBuffer(), mlir::sparse_tensor::genToPositions(), mlir::sparse_tensor::genToValues(), mlir::sparse_tensor::genTuple(), mlir::sparse_tensor::genValueForDense(), mlir::bufferization::getBuffer(), getCleanupLoopLowerBound(), getCollapsedOpOperand(), getConvOutputDim(), mlir::sparse_tensor::SparseTensorDescriptor::getCrdMemRefOrView(), getExpandedOutputDimFromInputShape(), mlir::sparse_tensor::getFunc(), getIndexedPtrs(), getIndicesForAccess(), mlir::sparse_tensor::SparseTensorSpecifier::getInitValue(), getLocationToWriteFullVec(), getMangledSortHelperFunc(), mlir::ConvertToLLVMPattern::getMemRefDescriptorSizes(), mlir::memref::getMixedSizes(), mlir::tensor::getMixedSizes(), mlir::ConvertToLLVMPattern::getNumElements(), getOffsetForBitwidth(), mlir::spirv::getOpenCLElementPtr(), mlir::tensor::getOrCreateDestination(), getOrCreateStep(), getOrDefineFunction(), getOrInsertBuiltinVariable(), getOrInsertPushConstantVariable(), getScalarOrVectorI32Constant(), getShapeDimSize(), mlir::ConvertToLLVMPattern::getSizeInBytes(), mlir::getValueOrCreateCastToIndexLike(), mlir::getValueOrCreateConstantIndexOp(), mlir::spirv::getVulkanElementPtr(), getZero(), handleByValArgumentInit(), handleInlinedAllocas(), hoistAffineIfOp(), mlir::linalg::hoistPaddingOnTensors(), inferDynamicDimsForConv(), mlir::sparse_tensor::LoopEmitter::initializeLoopEmit(), inlineIfCase(), inlineWhileCase(), insertConvResultSlices(), insertLastDimSlice(), insertOne(), mlir::sparse_tensor::insertYieldOp(), invertCollapseShapeIndexing(), linalgIntBroadcastExtSIAdd(), mlir::spirv::linearizeIndex(), mlir::LLVMTypeConverter::LLVMTypeConverter(), mlir::sparse_tensor::loadAll(), mlir::LLVM::lookupOrCreateFn(), mlir::loopUnrollByFactor(), mlir::affine::loopUnrollJamByFactor(), lowerAsEntryFunction(), lowerEntryPointABIAttr(), mlir::linalg::lowerPack(), mlir::linalg::lowerUnPack(), makeCanonicalAffineApplies(), mlir::affine::makeComposedAffineApply(), mlir::linalg::makeMemRefCopyOp(), mlir::linalg::makeTransposeOp(), mlir::transform::gpu::mapForallToBlocksImpl(), mlir::affine::mapLoopToProcessorIds(), mlir::transform::gpu::mapNestedForallToThreadsImpl(), mlir::transform::gpu::mapOneForallToThreadsImpl(), matchAndReplaceDepthwiseConv(), mlir::GPUFuncOpLowering::matchAndRewrite(), mlir::GPUPrintfOpToHIPLowering::matchAndRewrite(), mlir::GPUPrintfOpToLLVMCallLowering::matchAndRewrite(), mlir::GPUPrintfOpToVPrintfLowering::matchAndRewrite(), ConvertAccessChain::matchAndRewrite(), ConvertLoad::matchAndRewrite(), ConvertStore::matchAndRewrite(), SwapExtractSliceOfFill::matchAndRewrite(), mlir::linalg::GeneralizeOuterUnitDimsPackOpPattern::matchAndRewrite(), mlir::linalg::PadOpTransformationPattern::matchAndRewrite(), mlir::linalg::GeneralizePadOpPattern::matchAndRewrite(), mlir::linalg::GeneralizeOuterUnitDimsUnPackOpPattern::matchAndRewrite(), ConcatSliceOptimization::matchAndRewrite(), ConsolidateTransposeOptimization::matchAndRewrite(), mlir::linalg::LinalgCopyVTRForwardingPattern::matchAndRewrite(), mlir::linalg::LinalgCopyVTWForwardingPattern::matchAndRewrite(), mlir::affine::materializeComputedBound(), mlir::linalg::materializeTiledShape(), materializeToTensor(), mfmaConcatIfNeeded(), modifyFuncOpToUseBarePtrCallingConv(), movePaddingToFillOrGenericOp(), moveRegionToNewWarpOpAndReplaceReturns(), mlir::ArithBuilder::mul(), mlir::memref::multiBuffer(), normalizeLoop(), mlir::affine::normalizeMemRef(), mlir::MemRefDescriptor::offset(), mlir::UnrankedMemRefDescriptor::offset(), mlir::UnrankedMemRefDescriptor::offsetBasePtr(), ofrToIndexValues(), optionallyTruncateOrExtend(), outlineKernelFuncImpl(), mlir::outlineSingleBlockRegion(), mlir::linalg::pack(), padOperandToSmallestStaticBoundingBox(), padThroughLoopIterArg(), permuteVectorOffset(), mlir::bufferization::populateDynamicDimSizes(), mlir::LLVM::ModuleImport::processFunction(), processParallelLoop(), mlir::scf::promote(), mlir::affine::promoteIfSingleIteration(), mlir::LLVMTypeConverter::promoteOneMemRefDescriptor(), mlir::linalg::promoteSubviewAsNewBuffer(), rankReducingSubviewDroppingUnitDims(), reifyOrComputeDynamicSizes(), reifyValueBound(), replaceAndPropagateMemRefType(), replaceByPackingResult(), replaceConstantUsesOf(), replaceForAllWithNewSignature(), replaceForOpWithNewSignature(), mlir::affine::replaceForOpWithNewYields(), mlir::replaceLoopWithNewYields(), replaceUsesAndPropagateType(), mlir::sparse_tensor::reshapeCvs(), reshapeLoad(), reshapeStore(), mlir::sparse_tensor::reshapeValuesToLevels(), mlir::linalg::DownscaleConv2DOp::returningMatchAndRewrite(), mlir::linalg::DownscaleDepthwiseConv2DNhwcHwcOp::returningMatchAndRewrite(), mlir::linalg::rewriteAsPaddedOp(), mlir::linalg::rewriteInDestinationPassingStyle(), mlir::linalg::rewriteInIm2Col(), rewriteOneForallCommonImpl(), PadOpVectorizationWithInsertSlicePattern::rewriteUser(), mlir::ArithBuilder::select(), mlir::UnrankedMemRefDescriptor::setAlignedPtr(), mlir::UnrankedMemRefDescriptor::setAllocatedPtr(), mlir::UnrankedMemRefDescriptor::setOffset(), mlir::MemRefDescriptor::setOffset(), mlir::StructBuilder::setPtr(), mlir::UnrankedMemRefDescriptor::setSize(), mlir::MemRefDescriptor::setSize(), mlir::UnrankedMemRefDescriptor::setStride(), mlir::MemRefDescriptor::setStride(), mlir::ArithBuilder::sgt(), shiftValue(), mlir::UnrankedMemRefDescriptor::size(), mlir::MemRefDescriptor::size(), mlir::UnrankedMemRefDescriptor::sizeBasePtr(), sizesForTensor(), sliceTransferIndices(), mlir::ArithBuilder::slt(), sourceMaterializationCallback(), mlir::vector::splitFullAndPartialTransfer(), mlir::sparse_tensor::storeAll(), mlir::UnrankedMemRefDescriptor::stride(), mlir::MemRefDescriptor::stride(), mlir::UnrankedMemRefDescriptor::strideBasePtr(), stripmineSink(), mlir::ArithBuilder::sub(), mlir::LLVM::detail::LoopAnnotationImporter::translateAccessGroup(), transposeOneLinalgOperandAndReplace(), transposeToShuffle1D(), GenericPadOpVectorizationPattern::tryVectorizeCopy(), mlir::MemRefDescriptor::undef(), mlir::UnrankedMemRefDescriptor::undef(), mlir::ComplexStructBuilder::undef(), unpackOperandVector(), mlir::linalg::unrollIndex(), updateExpandedGenericOpRegion(), vectorizeAsLinalgGeneric(), vectorizeAsTensorPadOp(), mlir::linalg::vectorizeCopy(), wrapExternalFunction(), wrapForExternalCallers(), and yieldTiledValues().

create() [2/3]

Operation * OpBuilder::create	(	Location	loc,
		StringAttr	opName,
		ValueRange	operands,
		TypeRange	types = {},
		ArrayRef< NamedAttribute >	attributes = {},
		BlockRange	successors = {},
		MutableArrayRef< std::unique_ptr< Region >>	regions = {}
	)

Creates an operation with the given fields.

Definition at line 438 of file Builders.cpp.

References create().

create() [3/3]

template<typename OpTy , typename... Args>

OpTy mlir::OpBuilder::create ( Location  location, Args &&...  args  )

inline

Create an operation of specific op type at the current insertion point.

Definition at line 487 of file Builders.h.

References mlir::Location::getContext().

createBlock() [1/2]

Block * OpBuilder::createBlock	(	Block *	insertBefore,
		TypeRange	argTypes = std::nullopt,
		ArrayRef< Location >	locs = std::nullopt
	)

Add new block with 'argTypes' arguments and set the insertion point to the end of it.

The block is placed before 'insertBefore'. locs contains the locations of the inserted arguments, and should match the size of argTypes.

The block is placed before 'insertBefore'.

Definition at line 425 of file Builders.cpp.

References createBlock(), and mlir::Block::getParent().

createBlock() [2/2]

Block * OpBuilder::createBlock	(	Region *	parent,
		Region::iterator	insertPt = {},
		TypeRange	argTypes = std::nullopt,
		ArrayRef< Location >	locs = std::nullopt
	)

Add new block with 'argTypes' arguments and set the insertion point to the end of it.

The block is inserted at the provided insertion point of 'parent'. locs contains the locations of the inserted arguments, and should match the size of argTypes.

Definition at line 406 of file Builders.cpp.

References mlir::Block::addArguments(), mlir::Region::end(), mlir::Region::getBlocks(), listener, mlir::OpBuilder::Listener::notifyBlockCreated(), and setInsertionPointToEnd().

Referenced by addAtomicRMW(), buildGenericRegion(), buildSequenceBody(), checkAndNestUnderRewriteOp(), createAsyncDispatchFunction(), createBinarySearchFunc(), createBlock(), createDecl(), createElementFPowIFunc(), createElementIPowIFunc(), createPartitionFunc(), createQuickSortFunc(), createScanLoop(), createShiftDownFunc(), ensureDistinctSuccessors(), mlir::impl::ensureRegionTerminator(), mlir::sparse_tensor::LoopEmitter::enterCoIterationOverTensorsAtLvls(), fillStructuredOpRegion(), mlir::makeRegionIsolatedFromAbove(), movePaddingToFillOrGenericOp(), mlir::outlineSingleBlockRegion(), and mlir::linalg::rewriteInDestinationPassingStyle().

createOrFold() [1/3]

template<typename OpTy , typename... Args>

std::enable_if_t<OpTy::template hasTrait<OpTrait::OneResult>), Value> mlir::OpBuilder::createOrFold ( Location  location, Args &&...  args  )

inline

Overload to create or fold a single result operation.

Definition at line 520 of file Builders.h.

createOrFold() [2/3]

template<typename OpTy , typename... Args>

std::enable_if_t<OpTy::template hasTrait<OpTrait::ZeroResults>), OpTy> mlir::OpBuilder::createOrFold ( Location  location, Args &&...  args  )

inline

Overload to create or fold a zero result operation.

Definition at line 529 of file Builders.h.

createOrFold() [3/3]

template<typename OpTy , typename... Args>

void mlir::OpBuilder::createOrFold ( SmallVectorImpl< Value > &  results, Location  location, Args &&...  args  )

inline

Create an operation of specific op type at the current insertion point, and immediately try to fold it.

This functions populates 'results' with the results after folding the operation.

Definition at line 501 of file Builders.h.

References mlir::Location::getContext().

Referenced by broadcastIfNeeded(), buildLoopIterationCount(), mlir::bufferization::castOrReallocMemRefValue(), convertIntrinsicResult(), mlir::tensor::createCanonicalRankReducingExtractSliceOp(), mlir::tensor::createCanonicalRankReducingInsertSliceOp(), mlir::memref::createCanonicalRankReducingSubViewOp(), mlir::tensor::createDimValue(), mlir::tensor::createDimValues(), createFoldedComposedAffineApply(), createI32Constant(), mlir::vector::createOrFoldDimOp(), createOrFoldDimOp(), mlir::linalg::createOrFoldDimOp(), mlir::tensor::createPadHighOp(), doubleBuffer(), getCollapsedOutputDimFromInputShape(), getShapeDimSize(), mlir::linalg::lowerPack(), mlir::affine::makeComposedAffineMin(), mlir::linalg::GeneralizePadOpPattern::matchAndRewrite(), mlir::linalg::GeneralizeOuterUnitDimsUnPackOpPattern::matchAndRewrite(), mfmaConcatIfNeeded(), peelForLoop(), permuteVectorOffset(), and mlir::linalg::promoteSubviewAsNewBuffer().

getBlock()

Block* mlir::OpBuilder::getBlock ( ) const

inline

Returns the current block of the builder.

Definition at line 429 of file Builders.h.

Referenced by mlir::sparse_tensor::Merger::buildExp(), and mlir::sparse_tensor::createFuncCall().

getInsertionBlock()

Block* mlir::OpBuilder::getInsertionBlock ( ) const

inline

Return the block the current insertion point belongs to.

Note that the insertion point is not necessarily the end of the block.

Definition at line 423 of file Builders.h.

Referenced by mlir::affine::affineParallelize(), buildUnresolvedArgumentMaterialization(), checkAndNestUnderRewriteOp(), mlir::LLVM::createGlobalString(), mlir::sparse_tensor::LoopEmitter::enterCoIterationOverTensorsAtLvls(), mlir::sparse_tensor::LoopEmitter::enterFilterLoopOverTensorAtLvl(), mlir::sparse_tensor::LoopEmitter::enterLoopOverTensorAtLvl(), finalizeWhileOp(), replaceWithConstant(), and saveInsertionPoint().

getInsertionPoint()

Block::iterator mlir::OpBuilder::getInsertionPoint ( ) const

inline

Returns the current insertion point of the builder.

Definition at line 426 of file Builders.h.

Referenced by mlir::affine::affineParallelize(), broadcastIfNeeded(), buildUnresolvedArgumentMaterialization(), mlir::ConvertToLLVMPattern::copyUnrankedDescriptors(), mlir::sparse_tensor::LoopEmitter::initializeLoopEmit(), materializeConstant(), rewriteOneForallCommonImpl(), and saveInsertionPoint().

getListener()

Listener* mlir::OpBuilder::getListener ( ) const

inline

Returns the current listener of this builder, or nullptr if this builder doesn't have a listener.

Definition at line 301 of file Builders.h.

References listener.

Referenced by createAsyncDispatchFunction(), mlir::LLVM::createGlobalString(), createOrFold(), getOrInsertPushConstantVariable(), and materializeConstants().

insert()

Operation * OpBuilder::insert

(

Operation *

op

)

Insert the given operation at the current insertion point and return it.

Definition at line 397 of file Builders.cpp.

Referenced by create(), and mlir::impl::ensureRegionTerminator().

restoreInsertionPoint()

void mlir::OpBuilder::restoreInsertionPoint ( InsertPoint  ip )

inline

Restore the insert point to a previously saved point.

Definition at line 371 of file Builders.h.

References clearInsertionPoint(), mlir::OpBuilder::InsertPoint::getBlock(), mlir::OpBuilder::InsertPoint::getPoint(), mlir::OpBuilder::InsertPoint::isSet(), and setInsertionPoint().

Referenced by createPrintMsg(), and mlir::OpBuilder::InsertionGuard::~InsertionGuard().

saveInsertionPoint()

InsertPoint mlir::OpBuilder::saveInsertionPoint ( ) const

inline

Return a saved insertion point.

Definition at line 366 of file Builders.h.

References getInsertionBlock(), and getInsertionPoint().

Referenced by createPrintMsg().

setInsertionPoint() [1/2]

void mlir::OpBuilder::setInsertionPoint ( Block *  block, Block::iterator  insertPoint  )

inline

Set the insertion point to the specified location.

Definition at line 379 of file Builders.h.

Referenced by allocateSubviewGPUMemoryInAddressSpace(), applyTilingToAll(), mlir::tensor::buildIndependentOp(), buildPackingLoopNestImpl(), cloneAndFuseFirstUse(), mlir::linalg::collapseGenericOpIterationDims(), createDecl(), createGlobalVarForEntryPointArgument(), declareReduction(), doit(), mlir::bufferization::dropEquivalentBufferResults(), mlir::sparse_tensor::LoopEmitter::exitCurrentLoop(), mlir::linalg::fuseProducerOfTensor(), fuseWithReshapeByExpansion(), mlir::sparse_tensor::FuncCallOrInlineGenerator< SubClass >::genCallOrInline(), generateTileLoopNest(), getMangledSortHelperFunc(), mlir::OperationFolder::getOrCreateConstant(), mlir::tensor::getOrCreateDestination(), handleInlinedAllocas(), VectorizationState::initState(), inlineIfCase(), inlineWhileCase(), mlir::linalg::interchangeGenericOp(), mlir::loopUnrollByFactor(), mlir::linalg::lowerPack(), mlir::linalg::lowerUnPack(), InsertSliceOfInsertSliceFolder< OpTy >::matchAndRewrite(), moveRegionToNewWarpOpAndReplaceReturns(), mlir::memref::multiBuffer(), OpBuilder(), mlir::nvgpu::optimizeSharedMemoryReadsAndWrites(), mlir::outlineSingleBlockRegion(), mlir::linalg::packTranspose(), peelForLoop(), mlir::LLVM::ModuleImport::processFunction(), processParallelLoop(), replaceByPackingResult(), replaceForAllWithNewSignature(), replaceForOpWithNewSignature(), mlir::affine::replaceForOpWithNewYields(), mlir::replaceLoopWithNewYields(), replaceUnitDimIndexOps(), replaceUsesAndPropagateType(), restoreInsertionPoint(), rewriteOneForallCommonImpl(), PadOpVectorizationWithInsertSlicePattern::rewriteUser(), PadOpVectorizationWithTransferWritePattern::rewriteUser(), setInsertionPointToEnd(), setInsertionPointToStart(), mlir::vector::splitFullAndPartialTransfer(), tileAndFuseFirstExtractUse(), tileAndFuseFirstExtractUseThroughContainingOpBlockArgument(), mlir::scf::tileAndFuseProducerOfSlice(), mlir::transform::tileToForallOpImpl(), and vectorizeAsTensorPadOp().

setInsertionPoint() [2/2]

void mlir::OpBuilder::setInsertionPoint ( Operation *  op )

inline

Sets the insertion point to the specified operation, which will cause subsequent insertions to go right before it.

Definition at line 387 of file Builders.h.

setInsertionPointAfter()

void mlir::OpBuilder::setInsertionPointAfter ( Operation *  op )

inline

Sets the insertion point to the node after the specified operation, which will cause subsequent insertions to go right after it.

Definition at line 393 of file Builders.h.

Referenced by mlir::linalg::bufferizeToAllocation(), createAsyncDispatchFunction(), createBinarySearchFunc(), createChoosePivot(), createHeapSortFunc(), createInlinedCompareImplementation(), createInsert3rd(), createPartitionFunc(), createQuickSort(), createQuickSortFunc(), createScanLoop(), createShiftDownFunc(), createSort3(), createSort5(), createSortStableFunc(), destructureSlot(), doubleBuffer(), finalizeWhileOp(), hoistAffineIfOp(), mlir::linalg::hoistPaddingOnTensors(), mlir::affine::loopUnrollJamByFactor(), mlir::transform::gpu::mapOneForallToThreadsImpl(), mlir::linalg::offsetIndices(), padThroughLoopIterArg(), peelForLoop(), mlir::scf::pipelineForLoop(), replaceAndPropagateMemRefType(), mlir::linalg::rewriteAsPaddedOp(), mlir::linalg::rewriteInDestinationPassingStyle(), setInsertionPointAfter(), and updateExpandedGenericOpRegion().

setInsertionPointAfterValue()

void mlir::OpBuilder::setInsertionPointAfterValue ( Value  val )

inline

Sets the insertion point to the node after the specified value.

If value has a defining operation, sets the insertion point to the node after such defining operation. This will cause subsequent insertions to go right after it. Otherwise, value is a BlockArgument. Sets the insertion point to the start of its block.

Definition at line 402 of file Builders.h.

Referenced by alterGpuLaunch(), and createInlinedCompareImplementation().

setInsertionPointToEnd()

void mlir::OpBuilder::setInsertionPointToEnd ( Block *  block )

inline

Sets the insertion point to the end of the specified block.

Definition at line 417 of file Builders.h.

References mlir::Block::end(), and setInsertionPoint().

Referenced by addAtomicRMW(), mlir::scf::buildLoopNest(), mlir::LLVM::ModuleImport::convertMetadata(), createAsyncDispatchFunction(), createBinarySearchFunc(), createBlock(), createDecl(), createElementFPowIFunc(), createElementIPowIFunc(), createGpuLaunch(), createPartitionFunc(), createQuickSortFunc(), createScanLoop(), createShiftDownFunc(), mlir::impl::ensureRegionTerminator(), mlir::sparse_tensor::LoopEmitter::exitCurrentLoop(), finalizeWhileOp(), lowerEntryPointABIAttr(), mlir::linalg::makeTransposeOp(), outlineKernelFuncImpl(), mlir::outlineSingleBlockRegion(), mlir::replaceLoopWithNewYields(), and mlir::LLVM::detail::LoopAnnotationImporter::translateAccessGroup().

setInsertionPointToStart()

void mlir::OpBuilder::setInsertionPointToStart ( Block *  block )

inline

Sets the insertion point to the start of the specified block.

Definition at line 412 of file Builders.h.

References mlir::Block::begin(), and setInsertionPoint().

Referenced by addBodyWithPayloadOp(), mlir::linalg::bufferizeToAllocation(), buildAffineLoopNestImpl(), mlir::scf::buildLoopNest(), buildSequenceBody(), calculateTileOffsetsAndSizes(), mlir::async::cloneConstantsIntoTheRegion(), mlir::affine::coalesceLoops(), mlir::coalesceLoops(), mlir::spirv::combine(), createBinarySearchFunc(), createChoosePivot(), createCompareThenSwap(), createCtlzFunc(), createEqCompare(), createHeapSortFunc(), createLessThanCompare(), createPartitionFunc(), createPrintMsg(), createQuickSort(), createQuickSortFunc(), createShiftDownFunc(), createSortStableFunc(), destructureSlot(), endIf(), mlir::sparse_tensor::LoopEmitter::enterCoIterationOverTensorsAtLvls(), mlir::sparse_tensor::LoopEmitter::enterFilterLoopOverTensorAtLvl(), fillStructuredOpRegion(), fuseIfLegal(), mlir::sparse_tensor::FuncCallOrInlineGenerator< SubClass >::genCallOrInline(), generateCollapsedIndexingRegion(), generateFusedElementwiseOpRegion(), genIf(), mlir::sparse_tensor::genValueForDense(), getOrDefineFunction(), getOrInsertBuiltinVariable(), handleByValArgumentInit(), injectGpuIndexOperations(), mlir::makeRegionIsolatedFromAbove(), mlir::transform::gpu::mapForallToBlocksImpl(), mlir::GPUFuncOpLowering::matchAndRewrite(), mlir::GPUPrintfOpToHIPLowering::matchAndRewrite(), mlir::GPUPrintfOpToLLVMCallLowering::matchAndRewrite(), mlir::GPUPrintfOpToVPrintfLowering::matchAndRewrite(), modifyFuncOpToUseBarePtrCallingConv(), mlir::LLVM::ModuleImport::ModuleImport(), movePaddingToFillOrGenericOp(), mlir::memref::multiBuffer(), mlir::outlineSingleBlockRegion(), processParallelLoop(), mlir::linalg::rewriteInDestinationPassingStyle(), setInsertionPointAfter(), mlir::vector::splitFullAndPartialTransfer(), wrapExternalFunction(), and wrapForExternalCallers().

setListener()

void mlir::OpBuilder::setListener ( Listener *  newListener )

inline

Sets the listener of this builder to the one provided.

Definition at line 297 of file Builders.h.

References listener.

Referenced by createOrFold(), and materializeConstants().

tryFold()

LogicalResult OpBuilder::tryFold	(	Operation *	op,
		SmallVectorImpl< Value > &	results
	)

Attempts to fold the given operation and places new results within 'results'.

Returns success if the operation was folded, failure otherwise. Note: This function does not erase the operation on a successful fold.

Definition at line 451 of file Builders.cpp.

Member Data Documentation

listener

Listener* mlir::OpBuilder::listener

protected

The optional listener for events of this builder.

Definition at line 568 of file Builders.h.

Referenced by atBlockBegin(), mlir::ImplicitLocOpBuilder::atBlockBegin(), atBlockEnd(), mlir::ImplicitLocOpBuilder::atBlockEnd(), atBlockTerminator(), mlir::ImplicitLocOpBuilder::atBlockTerminator(), createBlock(), getListener(), mlir::RewriterBase::notifyMatchFailure(), and setListener().

---

The documentation for this class was generated from the following files:

• include/mlir/IR/Builders.h
• lib/IR/Builders.cpp