junrushao1994 commented on code in PR #12482: URL: https://github.com/apache/tvm/pull/12482#discussion_r948653342
########## include/tvm/script/ir_builder/base.h: ########## @@ -0,0 +1,302 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ +#ifndef TVM_SCRIPT_IR_BUILDER_BASE_H_ +#define TVM_SCRIPT_IR_BUILDER_BASE_H_ + +#include <tvm/ir/expr.h> +#include <tvm/ir/function.h> +#include <tvm/node/node.h> + +#include <vector> + +namespace tvm { +namespace script { +namespace ir_builder { + +////////////////////////////// IRBuilderFrame ////////////////////////////// + +/*! + * \brief A stack frame of the IRBuilder used to keep track of the current scope. + * Furthermore, the information stored in each stack frame can be useful for context-dependent + * IR construction. + * + * \example + * + * The `T::MatchBuffer` below adds an element in `PrimFuncNode::buffer_map`: + * + * \code {.cpp} + * + * using T = tvm::script::ir_builder::tir; + * With <PrimFuncFrame> _(...); + * Buffer buffer = T::MatchBuffer(...); + * + * \endcode + * + * The `T::MatchBuffer` below instead generates `MatchBufferRegion` in a TIR block: + * + * \code {.cpp} + * + * using T = tvm::script::ir_builder::tir; + * With <PrimFuncFrame> _(...); + * { + * With<BlockFrame> _2(...); + * Buffer buffer = T::MatchBuffer(...); + * } + * + * \endcode + */ +class IRBuilderFrameNode : public runtime::Object { + public: + /*! \brief A list of callbacks used when exiting the frame. */ + std::vector<runtime::TypedPackedFunc<void()>> callbacks; + + void VisitAttrs(tvm::AttrVisitor* v) { + // `callbacks` is not visited. + } + + static constexpr const char* _type_key = "script.ir_builder.IRBuilderFrame"; + TVM_DECLARE_BASE_OBJECT_INFO(IRBuilderFrameNode, runtime::Object); + + public: + /*! \brief Default destructor. */ + virtual ~IRBuilderFrameNode() = default; + /*! + * \brief The method called when entering RAII scope. + * \sa tvm::support::With + */ + virtual void EnterWithScope(); + /*! + * \brief The method called when exiting RAII scope. + * \sa tvm::support::With + */ + virtual void ExitWithScope(); + /*! + * \brief Add a callback method invoked when exiting the RAII scope. + * \param callback The callback to be added. + */ + void AddCallback(runtime::TypedPackedFunc<void()> callback); +}; + +/*! + * \brief Managed reference to an IRBuilderFrameNode. + * \sa IRBuilderFrameNode + */ +class IRBuilderFrame : public runtime::ObjectRef { + public: + /*! \brief Default destructor. */ + virtual ~IRBuilderFrame() = default; + TVM_DEFINE_MUTABLE_NOTNULLABLE_OBJECT_REF_METHODS(IRBuilderFrame, ObjectRef, IRBuilderFrameNode); + + protected: + /*! \brief Disallow direct construction of this object. */ + IRBuilderFrame() = default; + + public: + /*! + * \brief Redirected to `IRBuilderFrameNode::EnterWithScope`. + * \sa IRBuilderFrameNode::EnterWithScope + */ + inline void EnterWithScope() { + ICHECK(data_ != nullptr); + static_cast<IRBuilderFrameNode*>(data_.get())->EnterWithScope(); + } + /*! + * \brief Redirected to `IRBuilderFrameNode::ExitWithScope`. + * \sa IRBuilderFrameNode::ExitWithScope + */ + inline void ExitWithScope() { + ICHECK(data_ != nullptr); + static_cast<IRBuilderFrameNode*>(data_.get())->ExitWithScope(); + data_.reset(); + } +}; + +////////////////////////////// IRBuilder ////////////////////////////// + +/*! + * \brief A dialect-agnostic IRBuilder that constructs any IR of TVM. + * \example An idiomatic use of this class is to put this inside the RAII with-scope, + * call dialect-specific methods accordingly. Upon exiting the scope. Review Comment: ```suggestion * An idiomatic use of this class is to put this inside the RAII with-scope, * call dialect-specific methods accordingly. Upon exiting the scope. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
