tvm
function.h
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License. You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  */
19 
24 #ifndef TVM_IR_FUNCTION_H_
25 #define TVM_IR_FUNCTION_H_
26 
27 #include <tvm/ffi/container/array.h>
28 #include <tvm/ffi/container/map.h>
29 #include <tvm/ffi/string.h>
30 #include <tvm/ir/attrs.h>
31 #include <tvm/ir/expr.h>
32 
33 #include <string>
34 #include <type_traits>
35 
36 namespace tvm {
37 
44 enum class CallingConv : int {
51  kDefault = 0,
58  kCPackedFunc = 1,
66 };
67 
71 enum class LinkageType : int {
75  kInternal = 0,
80  kExternal = 1
81 };
82 
88 namespace attr {
96 constexpr const char* kCallingConv = "calling_conv";
97 
105 constexpr const char* kTarget = "target";
106 
126 constexpr const char* kGlobalSymbol = "global_symbol";
127 
128 } // namespace attr
129 
139 class BaseFuncNode : public RelaxExprNode {
140  public:
143 
163  template <typename TObjectRef>
164  Optional<TObjectRef> GetAttr(const std::string& attr_key,
165  Optional<TObjectRef> default_value = std::nullopt) const {
166  return attrs.GetAttr(attr_key, default_value);
167  }
168  // variant that uses TObjectRef to enable implicit conversion to default value.
169  template <typename TObjectRef>
170  Optional<TObjectRef> GetAttr(const std::string& attr_key, TObjectRef default_value) const {
171  return GetAttr<TObjectRef>(attr_key, Optional<TObjectRef>(default_value));
172  }
173 
193  bool HasNonzeroAttr(const std::string& attr_key) const { return attrs.HasNonzeroAttr(attr_key); }
214  if (GetAttr<String>(attr::kGlobalSymbol))
215  return LinkageType::kExternal;
216  else
217  return LinkageType::kInternal;
218  }
219 
220  static void RegisterReflection() {
221  namespace refl = tvm::ffi::reflection;
222  refl::ObjectDef<BaseFuncNode>().def_ro("attrs", &BaseFuncNode::attrs);
223  }
224 
225  static constexpr const char* _type_key = "ir.BaseFunc";
226  static constexpr const uint32_t _type_child_slots = 2;
228 };
229 
234 class BaseFunc : public RelaxExpr {
235  public:
237 };
238 
239 } // namespace tvm
240 #endif // TVM_IR_FUNCTION_H_
Helpers for attribute objects.
Base node of all functions.
Definition: function.h:139
static constexpr const uint32_t _type_child_slots
Definition: function.h:226
bool HasNonzeroAttr(const std::string &attr_key) const
Check whether the function has an non-zero integer attr.
Definition: function.h:193
LinkageType GetLinkageType() const
Get the type of the linkage.
Definition: function.h:213
Optional< TObjectRef > GetAttr(const std::string &attr_key, TObjectRef default_value) const
Definition: function.h:170
DictAttrs attrs
Additional attributes storing the meta-data.
Definition: function.h:142
static void RegisterReflection()
Definition: function.h:220
Optional< TObjectRef > GetAttr(const std::string &attr_key, Optional< TObjectRef > default_value=std::nullopt) const
Get a function attribute.
Definition: function.h:164
TVM_DECLARE_BASE_OBJECT_INFO(BaseFuncNode, RelaxExprNode)
static constexpr const char * _type_key
Definition: function.h:225
Managed reference to BaseFuncNode.
Definition: function.h:234
TVM_DEFINE_OBJECT_REF_METHODS(BaseFunc, RelaxExpr, BaseFuncNode)
Managed reference to DictAttrsNode.
Definition: attrs.h:166
bool HasNonzeroAttr(const std::string &attr_key) const
Check whether the function has an non-zero integer attr.
Definition: attrs.h:233
Optional< TObjectRef > GetAttr(const std::string &attr_key, Optional< TObjectRef > default_value=Optional< TObjectRef >(std::nullopt)) const
Get a function attribute.
Definition: attrs.h:197
Base node of all non-primitive expressions.
Definition: expr.h:422
Managed reference to RelaxExprNode.
Definition: expr.h:446
Base expr nodes in TVM.
constexpr const char * kCallingConv
Indicates the special calling convention.
Definition: function.h:96
constexpr const char * kTarget
Compilation target of the function.
Definition: function.h:105
constexpr const char * kGlobalSymbol
Global linker symbol of the function in generated code.
Definition: function.h:126
Definition: repr_printer.h:91
Performance counters for profiling via the PAPI library.
Definition: analyzer.h:37
CallingConv
Possible Calling conventions.
Definition: function.h:44
@ kDefault
Default calling convention.
@ kCPackedFunc
ffi::Function that exposes a Cffi::Function signature.
@ kDeviceKernelLaunch
Device kernel launch.
LinkageType
Supported linkage types.
Definition: function.h:71
@ kExternal
External linkage.
@ kInternal
Internal linkage.