function.h

Go to the documentation of this file.

/*
 * 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_TIR_FUNCTION_H_
#define TVM_TIR_FUNCTION_H_
 
#include <tvm/ffi/container/map.h>
#include <tvm/ffi/container/variant.h>
#include <tvm/ir/cow.h>
#include <tvm/ir/function.h>
#include <tvm/ir/prim/expr.h>
#include <tvm/runtime/tensor.h>
#include <tvm/tirx/expr.h>
#include <tvm/tirx/stmt.h>
 
#include <string>
 
namespace tvm {
namespace tirx {
 
class FunctionNode : public BaseFuncNode {
 public:
  ffi::Array<tvm::Var> params;
  Type ret_type = Type::Missing();
  ffi::Optional<SeqStmt> body;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<FunctionNode>()
        .def_ro("params", &FunctionNode::params, refl::AttachFieldFlag::SEqHashDefPattern())
        .def_ro("ret_type", &FunctionNode::ret_type)
        .def_ro("body", &FunctionNode::body);
    refl::TypeAttrDef<FunctionNode>()
        .def(tvm::ffi::reflection::type_attr::kSEqual, &FunctionNode::SEqual)
        .def(tvm::ffi::reflection::type_attr::kSHash, &FunctionNode::SHash);
  }
 
  bool SEqual(const FunctionNode* other,
              ffi::TypedFunction<bool(AnyView, AnyView, bool, AnyView)> equal) const {
    // `ty` is derived from the fields below.  Function transformations update
    // those source fields without maintaining this redundant cache eagerly.
    // Remove this exception once all Function mutation paths recompute `ty`.
    return equal(attrs, other->attrs, false, "attrs") &&
           equal(params, other->params, true, "params") &&
           equal(ret_type, other->ret_type, false, "ret_type") &&
           equal(body, other->body, false, "body");
  }
 
  int64_t SHash(int64_t init_hash, ffi::TypedFunction<int64_t(AnyView, int64_t, bool)> hash) const {
    int64_t hash_value = init_hash;
    hash_value = hash(attrs, hash_value, false);
    hash_value = hash(params, hash_value, true);
    hash_value = hash(ret_type, hash_value, false);
    hash_value = hash(body, hash_value, false);
    return hash_value;
  }
 
  TVM_TIRX_DLL FuncType func_type_annotation() const;
 
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("tirx.Function", FunctionNode, BaseFuncNode);
};
 
class Function : public BaseFunc {
 public:
  TVM_TIRX_DLL Function(ffi::Array<tvm::Var> params, ffi::Optional<SeqStmt> body,
                        Type ret_type = VoidType(), DictAttrs attrs = DictAttrs(),
                        Location loc = UnknownLoc());
 
  explicit Function(ffi::ObjectPtr<FunctionNode> node) : BaseFunc(std::move(node)) {}
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(Function, BaseFunc, FunctionNode);
  TVM_DEFINE_OBJECT_REF_COW_METHOD(FunctionNode);
};
 
TVM_TIRX_DLL Function RenewDef(Function func);
 
Function Specialize(Function func, const ffi::Map<Var, ffi::Variant<TensorVar, Expr>>& param_map);
 
namespace attr {
 
constexpr const char* kKernelLaunchParams = "tirx.kernel_launch_params";
 
constexpr const char* kNoAlias = "tirx.noalias";
 
constexpr const char* kIsEntryFunc = "tirx.is_entry_func";
 
constexpr const char* kIsGlobalFunc = "tirx.is_global_func";
 
constexpr const char* kIsHostFunc = "tirx.is_host_func";
 
constexpr const char* kPersistentKernel = "tirx.persistent_kernel";
 
}  // namespace attr
}  // namespace tirx
}  // namespace tvm
#endif  // TVM_TIR_FUNCTION_H_