// Copyright (c) 2023 PaddlePaddle Authors. All Rights Reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. #pragma once #include #include "paddle/phi/common/complex.h" #include "paddle/pir/include/core/block.h" #include "paddle/pir/include/core/ir_context.h" #include "paddle/pir/include/core/operation.h" namespace pir { class Type; class UndefinedType; class UInt8Type; class Int8Type; class Int16Type; class Int32Type; class VectorType; class BFloat16Type; class Float32Type; class Float64Type; class IndexType; class BoolType; class Complex64Type; class Complex128Type; class Float8E4M3FNType; class Float8E5M2Type; class StrAttribute; class BoolAttribute; class FloatAttribute; class DoubleAttribute; class Int32Attribute; class IndexAttribute; class Int64Attribute; class ArrayAttribute; class PointerAttribute; class TensorNameAttribute; class Complex64Attribute; class Complex128Attribute; using InsertionPoint = std::pair; /// /// \brief Unified interface of the Attribute class. Derivation of all Attribute /// classes only derives interfaces, not members. /// class Builder { public: Builder(IrContext *context, Block *block, Block::Iterator insertion_point, bool forbid_insert_without_position = true) : context_(context), insertion_point_(block, insertion_point), forbid_insert_without_position_(forbid_insert_without_position) {} Builder(IrContext *context, bool forbid_insert_without_position) : Builder(context, nullptr, Block::Iterator{}, forbid_insert_without_position) {} Builder(IrContext *context, Block *block) : Builder(context, block, block->end()) {} explicit Builder(IrContext *context) : Builder(context, nullptr, Block::Iterator{}) {} Builder(IrContext *context, const InsertionPoint &insert_point) : context_(context), insertion_point_(insert_point) {} void set_insertion_point(const InsertionPoint &insert_point) { insertion_point_ = insert_point; } /// Set the insert point to the start of the specified block. void SetInsertionPointToStart(Block *block) { set_insertion_point(block, block->begin()); } /// Set the insertion point to the specified location. void set_insertion_point(Block *block, Block::Iterator insert_point) { insertion_point_.first = block; insertion_point_.second = insert_point; } /// Set the insertion point to the specified operation, which will cause /// subsequent insertions to go right before it. void set_insertion_point(Operation *op) { set_insertion_point(op->GetParent(), Block::Iterator{*op}); } /// Set the insertion point to the node after the specified operation, which /// will cause subsequent insertions to go right after it. void SetInsertionPointAfter(Operation *op) { set_insertion_point(op->GetParent(), std::next(Block::Iterator{*op})); } /// Set the insertion point to the end of the specified block. void SetInsertionPointToBlockEnd(Block *block) { PADDLE_ENFORCE_NOT_NULL( block, common::errors::PreconditionNotMet("argument of block is nullptr")); set_insertion_point(block, block->end()); } /// Set/Get the op_role void set_op_role(int op_role) { op_role_ = op_role; } int op_role() const { return op_role_; } /// Set/Get the chunk_id void set_chunk_id(int chunk_id) { chunk_id_ = chunk_id; } int chunk_id() const { return chunk_id_; } /// Set/Get the comp_op_name void set_comp_op_name(std::string comp_op_name) { comp_op_name_ = comp_op_name; } std::string comp_op_name() const { return comp_op_name_; } IrContext *ir_context() const { return context_; } Block *block() const { return insertion_point_.first; } const InsertionPoint &insertion_point() const { return insertion_point_; } /// Creates an operation given the fields represented as an OperationState. IR_API Operation *Build(OperationArgument &&argument); /// Creates an operation with the given fields. IR_API Operation *Build(const std::vector &inputs, const AttributeMap &attribute, const std::vector &output_types, OpInfo op_info); IR_API Operation *Insert(Operation *op); /// Create an operation of specific op type at the current insertion point. template OpTy Build(Args &&...args); IR_API UndefinedType undefined_type(); IR_API BoolType bool_type(); IR_API UInt8Type uint8_type(); IR_API Int8Type int8_type(); IR_API Int16Type int16_type(); IR_API Int32Type int32_type(); IR_API VectorType vec_type(const std::vector &); IR_API BFloat16Type bfloat16_type(); IR_API IndexType index_type(); IR_API Float32Type float32_type(); IR_API Float64Type float64_type(); IR_API Complex64Type complex64_type(); IR_API Complex128Type complex128_type(); IR_API Float8E4M3FNType float8e4m3fn_type(); IR_API Float8E5M2Type float8e5m2_type(); IR_API StrAttribute str_attr(const std::string &value); IR_API BoolAttribute bool_attr(bool value); IR_API FloatAttribute float_attr(float value); IR_API DoubleAttribute double_attr(double value); IR_API Int32Attribute int32_attr(int32_t value); IR_API IndexAttribute index_attr(int64_t value); IR_API Int64Attribute int64_attr(int64_t value); IR_API ArrayAttribute array_attr(const std::vector &value); IR_API PointerAttribute pointer_attr(void *value); IR_API TensorNameAttribute tensor_name_attr(const std::string &value); IR_API Complex64Attribute complex64_attr(phi::dtype::complex value); IR_API Complex128Attribute complex128_attr(phi::dtype::complex value); private: IrContext *context_; InsertionPoint insertion_point_; bool forbid_insert_without_position_; // by now the op_role is used by autoparallel for distinguish the op in fw, // bw, opt region. int op_role_ = -1; int chunk_id_ = -1; // comp_op_name is used to specify the composite op name after decomposition std::string comp_op_name_ = ""; }; template OpTy Builder::Build(Args &&...args) { OperationArgument argument(context_->GetRegisteredOpInfo(OpTy::name())); OpTy::Build(*this, argument, std::forward(args)...); Operation *op = Build(std::move(argument)); return OpTy(op); } class BuilderAttrGuard { public: BuilderAttrGuard(std::shared_ptr builder, int op_role, int chunk_id, std::string comp_op_name); ~BuilderAttrGuard(); // forbid copy and operator= BuilderAttrGuard(const BuilderAttrGuard &guard) = delete; BuilderAttrGuard &operator=(const BuilderAttrGuard &guard) = delete; private: std::shared_ptr builder_; int pre_op_role_ = -1; int pre_chunk_id_ = -1; std::string pre_comp_op_name_ = ""; }; } // namespace pir