forked from neo-ai/tvm
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TIR] Introduce tir::PrimFunc (apache#5070)
This PR introduces tir::PrimFunc which will be used as the TIR function container in the unified IR. Also streamlined the function attributes a bit further. - All common attributes are under tvm::attr - TIR specific attributes are under tvm::tir::attr and comes with a tir prefix - Use stl_style for attributes for now
- Loading branch information
Showing
17 changed files
with
553 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,177 @@ | ||
/* | ||
* 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. | ||
*/ | ||
|
||
/*! | ||
* \file tvm/tir/function.h | ||
* \brief TIR Function. | ||
*/ | ||
#ifndef TVM_TIR_FUNCTION_H_ | ||
#define TVM_TIR_FUNCTION_H_ | ||
|
||
#include <tvm/ir/function.h> | ||
#include <tvm/tir/expr.h> | ||
#include <tvm/tir/buffer.h> | ||
#include <tvm/tir/stmt.h> | ||
#include <string> | ||
|
||
|
||
namespace tvm { | ||
namespace tir { | ||
|
||
/*! | ||
* \brief Primitive functions that contains TIR statements. | ||
* | ||
* The PrimFunc provides low-level code representation does not | ||
* automatically manage | ||
* | ||
* \sa PrimFunc | ||
*/ | ||
class PrimFuncNode : public BaseFuncNode { | ||
public: | ||
/*! \brief Function parameters */ | ||
Array<tir::Var> params; | ||
/*! \brief The body of the function */ | ||
tir::Stmt body; | ||
/*! \brief The return type of the function. */ | ||
Type ret_type; | ||
/*! | ||
* \brief Maps some parameters to specific Buffer data structures. | ||
* | ||
* buffer_map provides a way to express data structure's field and shape | ||
* constraints. The provided information is used in the program analysis | ||
* and the code generation. | ||
* | ||
* - It defines the vars in the Buffer (m, n) in the cases below when | ||
* they appears in the buffer_map for the first time. | ||
* - When a var appears multiple times, they translate into runtime | ||
* assertion to check the field constraint. | ||
* | ||
* \code | ||
* | ||
* # The corresponding fields of f are as follows | ||
* # | ||
* # - f.params = [a, b] | ||
* # - f.buffer_map = {a: A, b: B} | ||
* # - A = decl_buffer(shape=[m, n]) | ||
* # - B = decl_buffer(shape=[m, n]) | ||
* | ||
* def f(a, b): | ||
* m, n = var(), var() | ||
* A = bind_buffer(a, shape=[m, n]) | ||
* B = bind_buffer(b, shape=[m, n]) | ||
* # body | ||
* | ||
* \endcode | ||
* | ||
* buffer_map is a sugar to express: | ||
* - Parameter unpacking: e.g. I can load a.shape[0] to get value of m | ||
* - Constraint checking: a.shape[0] must equal b.shape[0] because they | ||
* both corresponds to m. | ||
* While we could have express parameter unpacking and constraint using | ||
* normal statements, making buffer_map as first class citizen of PrimFunc | ||
* will make program analysis much easier. | ||
* | ||
* \note This field can be nullptr | ||
*/ | ||
Map<tir::Var, Buffer> buffer_map; | ||
|
||
void VisitAttrs(tvm::AttrVisitor* v) { | ||
v->Visit("params", ¶ms); | ||
v->Visit("body", &body); | ||
v->Visit("ret_type", &ret_type); | ||
v->Visit("buffer_map", &buffer_map); | ||
v->Visit("attrs", &attrs); | ||
v->Visit("span", &span); | ||
v->Visit("_checked_type_", &checked_type_); | ||
} | ||
|
||
/*! | ||
* \brief Return the derived function annotation of this function. | ||
* | ||
* \return The function type annotation. | ||
* \note The function type annotation of PrimExpr is | ||
* directly derived from the Vars without the need of type inference. | ||
*/ | ||
TVM_DLL FuncType func_type_annotation() const; | ||
|
||
static constexpr const char* _type_key = "tir.PrimFunc"; | ||
TVM_DECLARE_FINAL_OBJECT_INFO(PrimFuncNode, BaseFuncNode); | ||
}; | ||
|
||
/*! | ||
* \brief Managed reference to PrimFuncNode. | ||
* \sa PrimFuncNode | ||
*/ | ||
class PrimFunc : public BaseFunc { | ||
public: | ||
/*! | ||
* \brief Constructor | ||
* \param params The parameters of the function. | ||
* \param body The body of the function. | ||
* \param ret_type The return type of the function. | ||
* \param buffer_map The buffer map for parameter buffer unpacking. | ||
* \param attrs Additional function attributes. | ||
*/ | ||
TVM_DLL PrimFunc(Array<tir::Var> params, | ||
Stmt body, | ||
Type ret_type = VoidType(), | ||
Map<tir::Var, Buffer> buffer_map = NullValue<Map<tir::Var, Buffer>>(), | ||
DictAttrs attrs = NullValue<DictAttrs>()); | ||
|
||
TVM_DEFINE_OBJECT_REF_METHODS(PrimFunc, BaseFunc, PrimFuncNode); | ||
TVM_DEFINE_OBJECT_REF_COW_METHOD(PrimFuncNode); | ||
}; | ||
|
||
/*! | ||
* \brief PrimFunc specific attribute names. | ||
* | ||
* \sa tvm::attr | ||
*/ | ||
namespace attr { | ||
/*! | ||
* \brief List of thread IterVar that a DeviceLaunch function corresponds to. | ||
* | ||
* Type: Array<tir::IterVar> | ||
* | ||
* We call a device kernel launch function f using the following convention: | ||
* | ||
* Call(f, | ||
* [arg1, arg2, ..., arg_n, | ||
* work_size_1, work_size_2, ... work_size_m]) | ||
* | ||
* Here n = len(arg), m = len(work_size) = len(device_thread_axis). | ||
* | ||
* The list of device_thread_axis indicates how can be bind the | ||
* work_size arguments to the corresponding threads. | ||
* | ||
* \sa tvm::CallingConv::kDeviceKernelLaunch | ||
*/ | ||
constexpr const char* kDeviceThreadAxis = "tir.device_thread_axis"; | ||
|
||
/*! | ||
* \brief Whether to set noalias rule on the function arguments. | ||
* | ||
* Type: Integer | ||
*/ | ||
constexpr const char* kNoAlias = "tir.noalias"; | ||
} // namespace attr | ||
} // namespace tir | ||
} // namespace tvm | ||
#endif // TVM_TIR_FUNCTION_H_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.